API Key erstellen

Ermöglicht dem Organisationsinhaber, einen API Key für einen Agent oder Workflow innerhalb der Organisation zu erstellen.

Über diesen Endpunkt können Sie für einen bestimmten Agent oder Workflow einen neuen API Key ausstellen und festlegen, ob der Key über die Berechtigung zur Versionsverwaltung verfügt. Nach der Erstellung können Sie mit dem zurückgegebenen API Key die ressourcenbezogenen Endpunkte dieses Agent oder Workflow aufrufen.

Anfragemethode

POST

Anfrage-URL

https://api.${endpoint}/v1/org/api-key/create

Authentifizierung der Anfrage

Verwendet die Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene. Das aufrufende Konto muss Inhaber der Organisation sein.

Anfrage

Beispielanfrage

curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -H 'Content-Type: application/json' \ -d '{ "org_id": "p-xxxx", "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0", "is_publish": true }'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/api-key/create' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "org_id": "p-xxxx",
    "agent_id": "68d0f1a2b3c4d5e6f7a8b9c0",
    "is_publish": true
  }'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.
Content-Type	application/json	Format des Anfrage-Body.

Anfrageparameter (Body Parameters)

Parameter	Typ	Beschreibung	required
org_id	String	Organisations-ID, erhältlich über den Endpunkt Organisationsliste abrufen.	true
agent_id	String	ID des Agent, für den der API Key erstellt werden soll. Schließt `workflow_id` aus; es darf nur einer der beiden Parameter übergeben werden.	false
workflow_id	String	ID des Workflow, für den der API Key erstellt werden soll. Schließt `agent_id` aus; es darf nur einer der beiden Parameter übergeben werden.	false
is_publish	Boolean	Ob für diesen API Key die Berechtigung zur Versionsverwaltung (Import, Versionsliste, Veröffentlichung, Rollback) aktiviert wird. Setzt nur die Berechtigung und löst keine Veröffentlichung aus. Muss ein JSON-Boolean `true` oder `false` sein; Werte wie `"true"` oder `1` werden nicht unterstützt.	true

Hinweise:

Für agent_id oder workflow_id muss genau ein nicht leerer Wert übergeben werden. Werden beide, keiner oder ein leerer String übergeben, wird ein Parameterfehler zurückgegeben.
Die ID muss zum Ressourcentyp passen: Wird eine Workflow-ID über agent_id oder eine Agent-ID über workflow_id übergeben, wird ein Typkonfliktfehler zurückgegeben.
Jeder Agent oder Workflow kann höchstens 10 API Keys besitzen. Ist das Limit erreicht, löschen Sie zunächst einen vorhandenen Key, bevor Sie einen neuen erstellen.
Der Name des neuen API Key wird automatisch im Format api- gefolgt von 12 zufälligen Zeichen generiert. Sie können ihn auf der Seite „API-Schlüssel“ in der Konsole einsehen oder ändern.
Dieser Endpunkt ist pro Konto begrenzt: höchstens 10 Aufrufe pro Minute und Konto.

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": { "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "api_key": "app-xxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
api_key	String	Der neu erstellte API Key zum Aufrufen der ressourcenbezogenen Endpunkte des entsprechenden Agent oder Workflow.

Bewahren Sie den zurückgegebenen API Key sicher auf. Die Antwort enthält den Header Cache-Control: no-store; speichern Sie den Key nicht im Klartext in Logs oder Caches.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Fehlercodes

Fehlercode	Beschreibung
40000	Parameterfehler, z. B. fehlender Pflichtparameter, `is_publish` ist kein Boolean, `agent_id` und `workflow_id` erfüllen nicht die Genau-einer-Regel, oder die Ressource hat ihr API-Key-Limit erreicht.
40101	Der Anfrage-Header `Authorization` ist leer.
40104	Das aktuelle Konto ist nicht Inhaber der Organisation.
40324	DevKey oder DevSecret ist ungültig.
40348	Der Agent oder Workflow existiert nicht oder gehört nicht zur Organisation.
403204	Die übergebene ID passt nicht zum Ressourcentyp (Agent / Workflow).

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler