Skip to main content
GET

Authentication

X-Agent-ID plus a signed x-agent-proof with scope: "read". See proof authentication.

Parameters

string
required
Approval ID belonging to this agent.

Response

200 returns the approval. Poll until status leaves pending. 404 approval_not_found means it does not exist or belongs to another agent.
string
Use this ID to poll or cancel.
string
pending, approved, denied, expired, cancelled or consumed.
string
api, policy or compute. tool and policy_rule are nullable; action_summary and nullable preview describe the action.
object
channel is email or sms; address is masked.
string
ISO deadline. created_at is the creation time; nullable use_by, decided_at and consumed_at record later stages.
string | null
Optional note. decided_via and decision_receipt_id are also nullable.
boolean
Whether the approver was notified. notify_error is null or approver notification failed.
object | null
goal_id and task_id for a compute approval.
For a policy approval, retry the held call with X-Approval-Id once approved.