Skip to main content
POST
Create Envelope

Authorizations

Authorization
string
header
required

Ingest API key or OIDC JWT. See /authentication.

Path Parameters

agent_id
string
required

Body

application/json
rules
EnvelopeRule · object[]
required
Minimum array length: 1
default_outcome
enum<string>
default:sync_review
Available options:
auto,
async_review,
sync_review,
block
deep_review_rate
number
default:0

Fraction of auto-executed decisions sampled into deep review

Required range: 0 <= x <= 1
note
string | null
Maximum string length: 500

Response

Successful Response

id
string
required
agent_id
string
required
version
integer
required
active
boolean
required
rules
any[]
required
default_outcome
string
required
deep_review_rate
number
required
note
string | null
required
created_by
string | null
required
created_at
string<date-time>
required