Playground

Playground

HITLApproval

/api/v1/chat/hitl

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

resolvegetPendinglistPending

Schema

FieldTypeNotes
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.
decisionenumapproved | rejectedApproval decision (set when resolving).
payloadjsonOptional overridden tool args to use if approved.
expires_atdate-timeApproval request expiry timestamp.
statusenumpending | approved | rejected | expiredCurrent approval status.

API

Loading manifest…