Resource envelope
Response structure for one Intelligence REST resource, with the result in data and separate attribution and request objects. The request object records the call's identifier, endpoint, server processing duration, caller tier, and scopes.
In plain language
The answer and the facts needed to identify and cite its call arrive together.
In a sentence
- The resource envelope kept the salary result beside its methodology link.
- We read the resource envelope's request identifier before filing a support ticket.
Usage note
The request block describes this call, while attribution describes the returned data. Keep both when saving an answer for later use.
See also
- 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?}}.
- List envelope
Response structure for an Intelligence REST collection, placing items in a data array beside pagination, attribution, and request metadata.
- Attribution block
Response object beside an Intelligence REST result that names Orbyt Intelligence as the source and gives its methodology link and version.
- Field shaping
Field shaping is the ?fields= query parameter, which keeps only the named parts of an Orbyt Intelligence response: a comma-separated list of paths such as role.title, estimate.median or cities[].slug, where * keeps everything.
Cite this term.
CC BY 4.0, attribution required.
Orbyt Labs, Resource envelope (Developer Glossary), Nov 6, 2026. https://
Orbyt Labs Glossaries (Nov 14, 2026), https://
Last updated .