1. Docs
2. Reference
3. REST API Docs
4. Schema
5. AgentBackendEventUserApprovalRequest

An event sent from the agent backend to the client during an agent task execution.

Properties

• id string required
  Unique identifier for the approval request.
• message string required
  Message to show to the user requesting approval.
• buttons array[string] optional
  Optional buttons for user interaction.
• source enum required
  Source of the approval request.
  Values: agent, system, hybrid
• approval_type enum required
  Type of approval being requested.
  Values: general, tool_permission, plan_exit
• context AgentBackendEventUserApprovalRequestContext optional
  Additional context for the approval request.
• ↳ tool_call_id string optional
  Tool call identifier associated with the approval request.
• ↳ tool_name string optional
  Tool name associated with the approval request.
• ↳ git_diff map[string]string optional
  Full Git diff patches indexed by filename for source changes.
• ↳ last_approval_diff map[string]string optional
  Git diff patches showing only the changes since the last approval (null for first approval).
• ↳ plan_description string optional
  Markdown description of the plan when exiting plan mode.
• sensitivity enum optional
  Distinguishes between moderate-sensitivity and high-sensitivity operations for auto-approval. Regular indicates moderate-sensitivity operations that will be auto-approved in both Balanced and Auto approval modes. Sensitive indicates very sensitive operations (e.g., pulumi up) that still require manual approval in Balanced mode and will only auto-approve in Auto mode. Defaults to Regular when not specified.
  Values: sensitive, regular
• timestamp string required
  When the event occurred.
• type string required