Get Route
Retrieve one route.
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_id
Hosted API id (prefixed external id, api_...).
route_id
Route id (prefixed external id, route_...).
Headers
Speechify-Version
Response headers
Speechify-Request-Id
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
OK
id
api_id
method
path
name
description
resolver
What answers a route. type selects the fields that apply:
store_query (store_id, collection, where, order_by, limit),
store_document (store_id, collection, document_id),
run_latest (trigger_id of a schedule trigger),
run (trigger_id of a webhook trigger, wait_seconds).
cache_ttl_seconds
Cache-Control max-age on GET responses; 0 disables caching.
enabled
created_at
updated_at
response_schema
Optional JSON Schema of the response body, rendered into the OpenAPI document.
Errors
400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error