Get Hosted API Usage | SpeechifyAI API

Today’s reads, runs and writes against the API’s daily caps, with each route’s share of the reads and writes. A read is a request a store, file or run_latest route answered from storage; a response served from the cache is not one. A write is a document a store_write route landed; a replayed Idempotency-Key is not one. counters_available is false where nothing counts (no Redis), so a zero is never mistaken for a quiet day. Dark launch: requires the hosted_apis_access entitlement (402 hosted_apis_not_in_plan otherwise).

Today's reads, runs and writes against the API's daily caps, with each route's share of the reads and writes. A read is a request a store, file or run_latest route answered from storage; a response served from the cache is not one. A write is a document a `store_write` route landed; a replayed Idempotency-Key is not one. `counters_available` is false where nothing counts (no Redis), so a zero is never mistaken for a quiet day. 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

daystring

The UTC day the counters cover, YYYY-MM-DD.

readslong

Reads served from storage today across the API's routes.

daily_read_capinteger

runslong

Runs started today through the API's run routes.

daily_run_capinteger

writeslong

Documents landed today through the API's write routes.

daily_write_capinteger

routeslist of objects

counters_availableboolean

False where nothing counts (no Redis); the numbers are then zero, not quiet.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

404

Not Found Error

1	{
2	"day": "2026-09-09",
3	"reads": 1,
4	"daily_read_cap": 1,
5	"runs": 1,
6	"daily_run_cap": 1,
7	"writes": 1,
8	"daily_write_cap": 1,
9	"routes": [
10	{
11	"route_id": "string",
12	"reads": 1,
13	"writes": 1
14	}
15	],
16	"counters_available": true
17	}