Skip to navigation
WorkspaceService AccountsAPI Keys

Create API key

Create a new API key for a service account

Path parameters

service_account_user_idstringRequired

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
namestringRequired
permissionslist of enums or "all"Required
The permissions of the XI API.
character_limitinteger or nullOptional
The character limit of the XI API key. If provided this will limit the usage of this api key to n characters per month where n is the chosen value. Requests that incur charges will fail after reaching this monthly limit.
allowed_ipslist of strings or nullOptional

List of IP addresses or CIDR ranges allowed to use this API key. Each entry may be a CIDR range (e.g. ‘10.0.0.0/24’) or a bare IP address (normalized to /32 or /128). On create, omit or pass null to allow all IPs. On update, omit to leave the allowlist unchanged, or pass “clear” to remove it.

third_party_disable_allowedboolean or nullOptional

Whether the holder of this key may disable it via the self-disable endpoint. On create, omit or pass null to use the workspace’s default (enabled for non-Enterprise plans, disabled for Enterprise plans). On update, omit to leave it unchanged, or pass “clear” to reset it to the workspace default. Only honored for workspaces with self-disable access enabled.

tts_concurrency_limitinteger or nullOptional

Maximum concurrent text-to-speech/speech-to-speech requests for this API key. Only available for enterprise customers.

dubbing_concurrency_limitinteger or nullOptional
Maximum concurrent dubbing requests for this API key. Only available for enterprise customers.
music_concurrency_limitinteger or nullOptional
Maximum concurrent music generation requests for this API key. Only available for enterprise customers.
expires_at_unixinteger or nullOptional

Unix timestamp (in seconds) after which this API key stops working. When set, it must be at least 15 minutes and at most 90 days in the future. On create, omit or pass null for a key that never expires. On update, omit to leave it unchanged, or pass “clear” to remove the expiry (never expires). A workspace may disallow never-expiring keys, or allow them only on service account API keys; creating one or clearing an expiry then fails.

Response

Successful Response
xi-api-keystring
key_idstring

Errors

422
Unprocessable Entity Error