Skip to main content
PUT
Attach or replace an inbox's extraction contract

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Path Parameters

inbox
string
required

Inbox UUID or full address (e.g. agent@dairo.app).

Body

application/json
schema
object

JSON-Schema-lite extraction contract: a flat map of field name to declaration. Identical shape to a template variables schema. '{}' (or omitted) means no contract (passthrough).

onValidationError
enum<string>
default:quarantine

Behaviour when an extracted object fails validation. 'quarantine' (default) holds the message out of message.received and emits message.quarantined; 'passthrough' delivers it with the error attached.

Available options:
quarantine,
passthrough
extractionHint
string | null

Optional free-text hint passed to the extractor as prompt context. Never executed.

Maximum string length: 1000

Response

Success

inboxId
string<uuid>
required
schema
object
required

JSON-Schema-lite extraction contract: a flat map of field name to declaration. Identical shape to a template variables schema. '{}' (or omitted) means no contract (passthrough).

onValidationError
enum<string>
required
Available options:
quarantine,
passthrough
extractionHint
string | null
createdAt
string<date-time>
updatedAt
string<date-time>