Zum Inhalt springen
Geprüft

Übersicht

Ein Endpunkt, eine Antwort-Hülle und die 337 Methoden, die ein API-Schlüssel erreichen kann.

Jeder Bildschirm im Xuda-Dashboard, jedes Studio-Programm und jede Integration von Drittanbietern ruft dieselbe HTTP-Oberfläche auf: CPI, kurz für den Methoden-Dispatcher der Plattform. Es gibt eine Endpunktform, /cpi/<method>, und eine Antwort-Hülle. Wenn du sie einmal kennst, kennst du alle 337 Methoden, die ein Konto-API-Schlüssel heute erreichen kann.

Der Endpunkt

POST https://xuda.ai/cpi/<method>GET  https://xuda.ai/cpi/<method>

<method> ist ein Methodenname wie get_account_projects oder dbs_read, nie ein Ressourcenpfad mit einer ID darin. Jede Eingabe, auch eine ID, ist ein Parameter: Bei POST ist sie ein Feld im JSON-Body, bei GET ein Query-String-Parameter (siehe Eine Methode aufrufen für die Regeln zu Body und Query sowie Beispiele in cURL, JavaScript und Python).

Diese Docs-Seite

Die Docs werden unter xuda.ai/docs ausgeliefert, deshalb ruft die Sandbox auf dieser Seite /cpi/<method> auf derselben Origin auf. Dein eigener Code ruft, wo auch immer er läuft, direkt https://xuda.ai/cpi/<method> auf.

Die Hülle

Jede Methode antwortet, ob Erfolg oder Fehler, in derselben Form:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 ist Erfolg. Die Zahl selbst hat keine weitere Bedeutung, außer positiv zu sein: Lies data.
  • code < 0 ist ein Fehler. data ist meist ein Meldungstext; ein Validierungsfehler fügt außerdem ein daraus abgeleitetes Feld message hinzu. Siehe Fehler für die Codes, auf die sich zu verzweigen lohnt, und die, die du nur protokollieren und anzeigen solltest.
  • Eine Methode, die eine Datei oder einen eigenen Inhaltstyp zurückgibt (ein CSV-Export, ein Bild), überspringt die JSON-Hülle und setzt stattdessen eigene Header und einen eigenen Body. Das ist die Ausnahme, nicht die Regel.
  • Eine erfolgreiche Antwort trägt einen Header xu-region, der die Xuda-Region nennt, die den Aufruf bearbeitet hat. Eine Fehlerantwort trägt ihn nicht.

Clearance und die private Mauer

Jede Methode hat eine clearance: public, user, user_access, developer oder admin. Sie legt fest, wer die Methode über eine angemeldete Dashboard-Sitzung erreichen darf: Eine public-Methode braucht nichts, alle anderen brauchen eine Sitzung auf dieser Stufe oder höher.

Ein API-Schlüssel ist eine eigene Mauer, keine weitere Clearance. Eine Methode trägt außerdem ein Flag private. private: true ist absolut: Kein API-Schlüssel kann sie aufrufen, auch keiner mit vollem Zugriff, unabhängig von der Clearance. Etwa ein Viertel des Katalogs ist in diesem Sinn öffentlich: 337 Methoden in 24 Microservices, von Voice und Domains bis zu Drive und der Studio-Authoring-API. Der Rest, darunter jede Methode von api_module selbst (die Methoden, die API-Schlüssel erstellen und verwalten), bleibt nur für Sitzungen. Authentifizierung behandelt vollen und benutzerdefinierten Schlüsselzugriff, und jeder Modul-Leitfaden unten endet mit der Live-Tabelle dessen, was sein Microservice bereitstellt.

Eine Methode finden

Die interaktive API-Referenz listet alle 337 Methoden mit ihren Feldern auf und lässt dich eine direkt im Browser gegen dein eigenes Konto ausführen.