Get IVR Menu
GET
https://api.speechify.ai/v1/agents/ivr-menus/:ivr_menu_id
Fetch one menu’s full shape. Returns 404 for missing, soft-deleted, or foreign-tenant menus — existence information is never leaked across tenants.
Authentication
AuthorizationBearer
Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.
Path parameters
ivr_menu_idstringRequired
IVR menu ID.
Headers
Speechify-VersionstringOptional
Response headers
X-Request-IDstring
Unique identifier for this request, present on every response (2xx and
non-2xx alike). If the caller sends an `X-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.
Response
The IVR menu detail.
idstring
format: "^menu_[0-9a-hjkmnp-tv-z]{26}$"Prefixed wire identifier (menu_<26 char Crockford base32>).
URL paths accept only this
prefixed form; legacy UUID path parameters are rejected with
404.
fingerprint_idstring
format: "^fp_[0-9a-hjkmnp-tv-z]{26}$"schema_versioninteger
menu_treeobject
Validated menu_tree per contracts/agents/ivr_menu.schema.json. Opaque to consumers other than the worker.
confidence_scorefloat
succeeded_traversalsinteger
total_traversalsinteger
last_validated_atdatetime
created_atdatetime
updated_atdatetime
invalidated_atdatetime or null
Errors
401
Unauthorized Error
404
Not Found Error