Get Hosted API OpenAPI Document

The OpenAPI 3.1 document describing the hosted API’s routes - the same document the API serves to its consumers at /openapi.json. A tool route’s request body is the operation’s own argument schema. When mcp_enabled is on, the document carries an x-speechify-mcp object (url, transport: streamable-http, description) naming where an MCP client attaches; the face speaks JSON-RPC, so it is an extension rather than a path. Dark launch: requires the hosted_apis_access entitlement (402 hosted_apis_not_in_plan otherwise).

The OpenAPI 3.1 document describing the hosted API's routes - the same document the API serves to its consumers at `/openapi.json`. A `tool` route's request body is the operation's own argument schema. When `mcp_enabled` is on, the document carries an `x-speechify-mcp` object (`url`, `transport: streamable-http`, `description`) naming where an MCP client attaches; the face speaks JSON-RPC, so it is an extension rather than a path. Dark launch: requires the `hosted_apis_access` entitlement (402 `hosted_apis_not_in_plan` otherwise).

Authentication

AuthorizationBearer

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

Path parameters

api_idstringRequired

Hosted API id (prefixed external id, api_...).

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 OpenAPI document.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error