Docs

Docs

x-cpod-domain: chat

Chat HITL

Chat human-in-the-loop approvals — resolve agent tool-call approval requests paused during AI execution.

Try in explorer client.chat

HITLApproval

A pending human-in-the-loop tool-call approval emitted when an agent requires gating.

REST path/api/v1/chat/hitl
Operations
resolvegetPendinglistPending
SDK
// list — returns only your records; add filters/search:
await client.chat.list()
FieldTypeDescription
approval_id*uuidHITL approval identifier from the SSE event.
tool_name*stringName of the tool awaiting approval.
tool_args*jsonArguments the agent intends to pass to the tool.
decisionenumApproval decision (set when resolving).approvedrejected
payloadjsonOptional overridden tool args to use if approved.
expires_atdate-timeApproval request expiry timestamp.
statusenumCurrent approval status.pendingapprovedrejectedexpired