ApprovalAction

An approval decision supplied when resuming a paused agent execution. When an agent execution pauses to request approval for an elevated action, SendMessage streams an approval request carrying interrupt identifiers. This structure carries the decision back to the service — which paused tool invocation is being resumed, the opaque interrupt identifier that resumes it, the identifier of the approval request being resolved, optional display text of the control the user chose, and the action taken (APPROVED or REJECTED) — so the service can resume the paused execution. All members are optional on the wire; service-side validation is applied against the populated subset.

action

The action taken on the approval request — APPROVED or REJECTED.

Type: String

Valid Values: APPROVED | REJECTED

Required: No

approvalId

Identifier of the approval request being resolved.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}

Required: No

buttonText

Optional display text of the UI control the user chose (for example, "Approve Exact", "Approve Broader", or "Reject"), provided as auxiliary decision context.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

interruptId

An opaque resume identifier issued by the service when an agent execution pauses for approval. Provide it when resuming so the service can resume the correct paused execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

toolUseId

Identifier of the specific paused tool invocation that requested approval. Correlates the approval decision back to the paused invocation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

ApprovalAction

Contents

See Also