Zur Navigation springen

API-Schlüssel erstellen

Erstellen Sie einen neuen API-Schlüssel für ein Dienstkonto.

Pfadparameter

service_account_user_idstringErforderlich

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
namestringErforderlich
permissionslist of enums or "all"Erforderlich
Die Berechtigungen der XI API.
character_limitinteger or nullOptional

Das Zeichenlimit des XI-API-Schlüssels. Wenn angegeben, begrenzt dies die Nutzung dieses API-Schlüssels auf n Zeichen pro Monat, wobei n dem gewählten Wert entspricht. Kostenpflichtige Anfragen schlagen fehl, sobald dieses monatliche Limit erreicht ist.

allowed_ipslist of strings or nullOptional

Liste der IP-Adressen oder CIDR-Bereiche, die diesen API-Schlüssel verwenden dürfen. Jeder Eintrag kann ein CIDR-Bereich (z. B. ‘10.0.0.0/24’) oder eine einzelne IP-Adresse sein (normalisiert auf /32 bzw. /128). Beim Erstellen weglassen oder null übergeben, um alle IPs zuzulassen. Beim Aktualisieren weglassen, um die Zulassungsliste unverändert zu lassen, oder “clear” übergeben, um sie zu entfernen.

third_party_disable_allowedboolean or nullOptional

Gibt an, ob der Inhaber dieses Schlüssels ihn über den Self-Disable-Endpunkt deaktivieren darf. Beim Erstellen auslassen oder null übergeben, um den Standardwert des Workspace zu verwenden (aktiviert für Nicht-Enterprise-Pläne, deaktiviert für Enterprise-Pläne). Beim Aktualisieren auslassen, um den Wert unverändert zu lassen, oder “clear” übergeben, um ihn auf den Workspace-Standard zurückzusetzen. Wird nur für Workspaces mit aktiviertem Self-Disable-Zugriff berücksichtigt.

tts_concurrency_limitinteger or nullOptional

Maximale Anzahl gleichzeitiger Text-to-Speech-/Speech-to-Speech-Anfragen für diesen API-Schlüssel. Nur für Enterprise-Kunden verfügbar.

dubbing_concurrency_limitinteger or nullOptional

Maximale Anzahl gleichzeitiger Synchronisationsanfragen für diesen API-Schlüssel. Nur für Enterprise-Kunden verfügbar.

music_concurrency_limitinteger or nullOptional

Maximale Anzahl gleichzeitiger Musikgenerierungsanfragen für diesen API-Schlüssel. Nur für Enterprise-Kunden verfügbar.

expires_at_unixinteger or nullOptional

Unix-Zeitstempel (in Sekunden), nach dem dieser API-Schlüssel nicht mehr funktioniert. Wenn gesetzt, muss er mindestens 15 Minuten und höchstens 90 Tage in der Zukunft liegen. Beim Erstellen weglassen oder null übergeben, damit der Schlüssel nie abläuft. Beim Aktualisieren weglassen, um ihn unverändert zu lassen, oder “clear” übergeben, um das Ablaufdatum zu entfernen (läuft nie ab).

Antwort

Erfolgreiche Antwort
xi-api-keystring
key_idstring

Fehler

422
Unprocessable Entity Error