Cancel an agent message
cancel_agent_messageDestructiveIdempotent
Stop a queued or running turn for Studio, the Workflow Agent, or a deployed agent and return its final status. Cancel work still in progress; usage up to cancellation remains billed.
Instructions
Stop a turn that Studio, the Workflow Agent or one of your deployed agents is still working on. Only queued or running turns can be cancelled; a finished turn is reported as it ended. The turn can still finish normally if it was already completing, so the final status is read back and returned. Usage up to the cancel stays billed. For Studio, model runs the turn already started keep running and cannot be stopped from here; list_studio_results shows them.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent | Yes | Which agent: "studio" (Wiro Studio, the media agent that runs models for you), "workflow-agent" (the Workflow Agent, which designs Wiro workflows) or the guid of one of your deployed agents (from list_my_agents). | |
| session | No | The session the message was sent in. Required for Studio and the Workflow Agent unless it was "default". | |
| message_id | Yes | The message id from send_agent_message. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent | Yes | ||
| notes | Yes | ||
| message | No | ||
| session | No | ||
| agentKind | Yes | ||
| messageId | Yes | ||
| finalState | No | ||
| finalStatus | No | ||
| cancelAccepted | Yes |