Skip to main content
Every failure Cortex returns is an application/problem+json document:

Fields

Rendering rules

The web app renders catalog copy for a code rather than the wire text. If you are building a client against these documents, do the same.
  • Render your own copy for code. The catalog page for each code explains the situation in product language.
  • Do not render detail. It is diagnostic text, and it may name an internal component or a specific resource id.
  • Three codes may show detail as a secondary line: validation_failed, bad_request, and invalid_state. Even there it is supplementary, not the message.
  • User-facing text never names a vendor. detail names a Cortex surface — The audio service is temporarily unavailable. — never a subprocessor.

Handling a code

Full list with statuses and retry guidance: Problem catalog.