Developer Glossary

Error envelope

The error envelope is the shape of every Orbyt Intelligence API error: {error: {type, code, param?, message, doc_url, request_id, retry_strategy, retry_hint?, follow_up_suggestions?}}. Branch on error.code, which is stable; error.message is written for people and may change. Error codes are only ever added, never removed, for the life of v1.

Error code registry

See also

  • Retry strategy

    Machine readable field on a structured Intelligence REST error that names the next action: do_not_retry, retry_after_seconds, retry_with_clarification, or use_alternative_tool.

  • request_id

    A request_id is the identifier Orbyt gives every Intelligence API request: req_ followed by 16 hex characters.

  • Resource envelope

    Response structure for one Intelligence REST resource, with the result in data and separate attribution and request objects.

  • Orbyt-Version

    Orbyt-Version is the response header that names the dated contract an Orbyt Intelligence API response follows, in YYYY-MM-DD form.

Cite this term.

CC BY 4.0, attribution required.

This term

Orbyt Labs, Error envelope (Developer Glossary), Nov 6, 2026. https://www.orbytlabs.ai/developers/glossary/error-envelope

The dataset (JSON)

Orbyt Labs Glossaries (Nov 14, 2026), https://www.orbytlabs.ai/glossary#dataset

Last updated .