Skip to main content
POST
Invoke the Omni agent

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
organizationId
string
Maximum string length: 120
thread_id
string | null
Required string length: 1 - 200
channel
string
Required string length: 1 - 64
messages
object[]
Maximum array length: 50
config
object
decisions
object[]
Maximum array length: 20

Response

The agent finished or is waiting for approval.

run_id
string
required
thread_id
string
required
status
enum<string>
required
Available options:
queued,
running,
completed,
awaiting_approval,
failed
messages
object[]
required
structured_output
object | null
required
approvals
object[] | null
required
error
string | null
required