Skip to navigation

Get Workspace Entitlements

Beta

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.voice_cloning and current.hosted_apis_access, and size traffic from current.tts_requests_per_second and current.tts_concurrency. 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_…’.

Headers

Speechify-VersionstringOptional

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

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
429
Too Many Requests Error
500
Internal Server Error