workspace

Create Service Account Api Key

Changed on

Create a new API key for a service account

post/v1/service-accounts/{service_account_user_id}/api-keys

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/service-accounts/{service_account_user_id}/api-keys
  • Auth
    none declared

Path parameters

service_account_user_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring required
character_limitinteger nullable

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_ipsstring[] nullable

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 nullable

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 nullable

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

dubbing_concurrency_limitinteger nullable

Maximum concurrent dubbing requests for this API key. Only available for enterprise customers.

music_concurrency_limitinteger nullable

Maximum concurrent music generation requests for this API key. Only available for enterprise customers.

expires_at_unixinteger nullable

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).

Example request

{
  "expires_at_unix": 1735689600
}

Response

Successful Response

xi-api-keystring required
key_idstring required

Changes

  • 169936a30a2dRevision changes
    • info

      added the new optional request property

  • bfa9d7a4aa2aRevision changes
    • info

      added the new voice_collections_read enum value to the request property //

    • info

      added the new voice_collections_write enum value to the request property //