API-Referenz
API-Referenz
Öffentliche API-Familien, Authentifizierung und Konventionen, abgeleitet aus Route Map und Routendateien.
Authentifizierung
Die öffentlichen /api/v1 Endpunkte erwarten einen OIDC Bearer Token oder einen passenden API-Schlüssel mit Scope. Tenant, User und Rolle werden serverseitig aus dem geprüften Token, dem API-Schlüssel oder gespeicherten Mitgliedschaften abgeleitet.
curl https://api.oap.exoscale.cloud/api/v1/agents \
-H "Authorization: Bearer $TOKEN"const res = await fetch("/api/v1/agents", {
headers: { Authorization: `Bearer ${token}` }
});import requests
res = requests.get(
"https://api.oap.exoscale.cloud/api/v1/agents",
headers={"Authorization": f"Bearer {token}"},
)Basis und Konventionen
Die API-Basis ist /api/v1. Der Ingress leitet Pfadfamilien an Services wie oap-iam, oap-agent-mgmt, oap-runtime, oap-knowledge, oap-tools, oap-models und oap-governance. Fehler erscheinen in den Routendokumenten überwiegend als feste Error-Codes mit Message. Pagination und Filter sind pro Service implementiert und nicht als ein globales Format zu erfinden.
Tenant-Kontext wird nicht als vertrauenswürdiger Body-Wert behandelt. Clients verwenden den gesetzten Login-Kontext, API-Key-Scope oder explizit erlaubte Tenant-Auswahl.
Agent Management
GET/api/v1/agentsoap-agent-mgmtAgenten des aktuellen Kontextes listen.
POST/api/v1/agentsoap-agent-mgmtAgent anlegen oder Entwurf erstellen, abhängig von Rolle und Servicevalidierung.
GET/api/v1/agents/:idoap-agent-mgmtAgentendetails abrufen.
PATCH/api/v1/agents/:idoap-agent-mgmtAgentendaten aktualisieren.
POST/api/v1/agents/:id/deployoap-agent-mgmtAgent freigeben oder bereitstellen, wenn Gates erfüllt sind.
Runtime und Sessions
GET/api/v1/sessionsoap-runtimeChat-Sitzungen listen.
POST/api/v1/sessionsoap-runtimeSitzung erstellen.
POST/api/v1/sessions/:id/messagesoap-runtimeNachricht senden, Streaming läuft über die Runtime-Routen.
GET/api/v1/open-botoap-runtimeOpen-Bot-Flächen und Kontext abrufen.
POST/v1/chat/completionsoap-runtimeOpenAI-kompatibler Chat-Completions-Endpunkt.
Wissen und Dateien
GET/api/v1/knowledge-basesoap-knowledgeWissensbasen listen.
POST/api/v1/knowledge-basesoap-knowledgeWissensbasis anlegen.
GET/api/v1/vector-storesoap-knowledgeVektor-Stores abrufen.
POST/api/v1/file-searchoap-knowledgeDateisuche ausführen.
Werkzeuge, Kanäle und Verbindungen
GET/api/v1/toolsoap-toolsWerkzeugkatalog abrufen.
GET/api/v1/connectionsoap-toolsVerbindungen listen, wenn Connections aktiviert ist.
POST/api/v1/connections/oauth/startoap-toolsOAuth-Fluss für eine Verbindung starten.
POST/api/v1/connections/oauth/callbackoap-toolsOAuth-Callback aus der Web-Callback-Seite abschließen.
DELETE/api/v1/connections/:idoap-toolsVerbindung lokal widerrufen und Vendor-Revocation versuchen.
IAM und Governance
GET/api/v1/auth/verifyoap-iamToken prüfen.
GET/api/v1/tenantsoap-iamMandanten im erlaubten Kontext listen.
GET/api/v1/usersoap-iamNutzerverwaltung, rollenabhängig.
GET/api/v1/auditoap-iamAudit-Ereignisse lesen.
GET/api/v1/guardrailsoap-governanceGuardrail-Konfiguration abrufen.
GET/api/v1/cost-reportingoap-governanceKosten- und Verbrauchsdaten abrufen.
Modelle und Gateway
GET/api/v1/models/catalogoap-modelsModellkatalog abrufen.
GET/api/v1/models/registrationsoap-modelsRegistrierte Modelle abrufen.
GET/api/v1/tenant-gatewayoap-modelsTenant-Gateway-Konfiguration.
GET/v1/modelsoap-runtimeOpenAI-kompatible Modellliste.
Aus dem Quellcode erzeugt: commit 04b00786
Grundlage im Repository
docs/platform/route-map.mdapps/oap-iam/src/routes/auth.tsapps/oap-agent-mgmt/src/routesapps/oap-runtime/api/src/routes/sessionsapps/oap-knowledge/api/src/routesapps/oap-tools/src/connections/oauth/routes.ts