Skip to content

ApprovalAction

Source code in docs_src/capo_devops_agent/types/approval_action.py
class ApprovalAction(TypedDict, closed=True):
    tool_use_id: NotRequired["capo_devops_agent.types.tool_use_id.ToolUseId"]
    """<p>Identifier of the specific paused tool invocation that requested approval. Correlates the approval decision back to the paused invocation.</p>"""
    interrupt_id: NotRequired["capo_devops_agent.types.interrupt_id.InterruptId"]
    """<p>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.</p>"""
    approval_id: NotRequired["capo_devops_agent.types.approval_id.ApprovalId"]
    """<p>Identifier of the approval request being resolved.</p>"""
    button_text: NotRequired["capo_devops_agent.types.button_text.ButtonText"]
    """<p>Optional display text of the UI control the user chose (for example, "Approve Exact", "Approve Broader", or "Reject"), provided as auxiliary decision context.</p>"""
    action: NotRequired[
        "capo_devops_agent.types.approval_action_type.ApprovalActionType"
    ]
    """<p>The action taken on the approval request — APPROVED or REJECTED.</p>"""

action instance-attribute

action: NotRequired[ApprovalActionType]

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

approval_id instance-attribute

approval_id: NotRequired[ApprovalId]

Identifier of the approval request being resolved.

button_text instance-attribute

button_text: NotRequired[ButtonText]

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

interrupt_id instance-attribute

interrupt_id: NotRequired[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.

tool_use_id instance-attribute

tool_use_id: NotRequired[ToolUseId]

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