Get Workspace Entitlements

Beta

GET

https://api.speechify.ai/v1/workspaces/current/entitlements

GET

/v1/workspaces/current/entitlements

$ curl https://api.speechify.ai/v1/workspaces/current/entitlements \
>      -H "Authorization: Bearer <token>"

1 {
2   "catalog": {
3     "pro": {
4       "phone_number_quota": 5,
5       "concurrent_call_cap": 5,
6       "max_members": 1,
7       "max_call_duration_seconds": 30,
8       "max_service_accounts": 50,
9       "tts_requests_per_second": 20,
10       "tts_concurrency": 15,
11       "agent_requests_per_second": 20,
12       "agent_concurrency": 30,
13       "max_llm_model_class": "premium",
14       "can_create_workspaces": true,
15       "topup_allowed": true,
16       "voice_cloning": true,
17       "batch_calls": true,
18       "custom_llm_endpoint": true,
19       "waymark_access": false,
20       "text_agent_access": false,
21       "enterprise_sso": false
22     }
23   },
24   "current": {
25     "phone_number_quota": 5,
26     "concurrent_call_cap": 5,
27     "max_members": 1,
28     "max_call_duration_seconds": 30,
29     "max_service_accounts": 50,
30     "tts_requests_per_second": 20,
31     "tts_concurrency": 15,
32     "agent_requests_per_second": 20,
33     "agent_concurrency": 30,
34     "max_llm_model_class": "premium",
35     "can_create_workspaces": true,
36     "topup_allowed": true,
37     "voice_cloning": true,
38     "batch_calls": true,
39     "custom_llm_endpoint": true,
40     "waymark_access": false,
41     "text_agent_access": false,
42     "durable_runs_access": true,
43     "max_run_turns": 20,
44     "slack_channel_access": true,
45     "hosted_apis_access": true,
46     "max_store_documents": 1,
47     "max_store_bytes": 1,
48     "skills_access": true,
49     "max_skills": 1,
50     "max_skills_per_agent": 1,
51     "enterprise_sso": false,
52     "phone_relay": true,
53     "phone_sms": true,
54     "zero_data_retention": true,
55     "voice_cloning_consent_exempt": true,
56     "max_manual_top_up_usd": 1,
57     "max_auto_recharge_charge_usd": 1
58   }
59 }

The per-tier entitlements catalog plus the caller’s RESOLVED entitlements for the current workspace (tier defaults composed with any per-tenant override). Readable with an API key as well as a console session: it is how an integration learns what it may use before a feature endpoint answers 402. Branch on current.durable_runs_access, current.text_agent_access, current.hosted_apis_access and current.skills_access, and size a run from current.max_run_turns. The console renders quota affordances and upgrade-card limits from the same single server-authoritative source instead of a hardcoded mirror.

The per-tier entitlements catalog plus the caller's RESOLVED entitlements for the current workspace (tier defaults composed with any per-tenant override). Readable with an API key as well as a console session: it is how an integration learns what it may use before a feature endpoint answers `402`. Branch on `current.durable_runs_access`, `current.text_agent_access`, `current.hosted_apis_access` and `current.skills_access`, and size a run from `current.max_run_turns`. The console renders quota affordances and upgrade-card limits from the same single server-authoritative source instead of a hardcoded mirror.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Response headers

Speechify-Request-IdstringOptional

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a Speechify-Request-Id request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests

it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

The legacy alias X-Request-ID carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

The entitlements catalog + the current workspace’s resolved entitlements.

catalogmap from strings to objects

Per-tier floor entitlements, keyed by tier string.

currentobject

Customer-facing per-tier limits + feature flags, including the API rate limits the plan enforces. Numeric fields are caps; booleans gate features.

Errors

401

Unauthorized Error

Authentication

Headers

Response headers

Response

Errors