Get an inbox's extraction contract
Returns the extraction contract attached to the inbox, including its schema map, the onValidationError policy (quarantine or passthrough), any extractionHint, and createdAt/updatedAt timestamps.
Returns the extraction contract attached to the inbox, including its schema map, the onValidationError policy (quarantine or passthrough), any extractionHint, and createdAt/updatedAt timestamps. The {inbox} path segment accepts either the inbox UUID or its full address (e.g. agent@dairo.app); a value containing @ is resolved by address, otherwise by id. Requires the inboxes:read scope. An inbox outside your active organization returns 404, and an owned inbox that has no contract attached also returns 404 — a distinct No schema attached to this inbox case you can treat as passthrough delivery.
Scope: inboxes:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
inbox | string | yes | Inbox UUID or full address (e.g. agent@dairo.app). |
Response
200 Success. Body: application/json, InboxSchemaResponse.
| Field | Type | Required | Description |
|---|---|---|---|
inboxId | string (uuid) | yes | |
schema | InboxSchemaContract | yes | |
onValidationError | "quarantine", "passthrough" | yes | |
extractionHint | string or null | no | |
createdAt | string (date-time) | no | |
updatedAt | string (date-time) | no |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |