Skip to main content
POST
Create Service Account Api Key

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

service_account_user_id
string
required

Body

application/json
name
string
required
permissions
required

The permissions of the X API key.

Public API-key permission universe supported by Threetone.

Available options:
models_read,
voices_read,
voices_write,
workspace_read,
workspace_write,
convai_read,
convai_write,
create_user_api_key,
workspace_analytics_full_read,
webhooks_write,
service_account_write,
group_members_manage,
workspace_members_read,
workspace_members_invite,
workspace_members_remove,
terms_of_service_accept,
audit_log_read,
conversation_privacy_manage,
copy_resources_cross_workspace
credit_limit
integer | null

The credit limit of the API key per credit refresh period. If omitted, the key does not have its own credit cap.

allowed_ips
string[] | null

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). Omit or pass null to allow all IPs.

Required array length: 1 - 100 elements
third_party_disable_allowed
boolean | null

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. Only honored for workspaces with self-disable access enabled.

Response

Successful Response

x-api-key
string
required
key_id
string
required