Agents

Cancel the active run

Cancel the session's active run.

post/v1/agents/{agent_id}/sessions/{session_id}/cancel

Request

  • Base URL
    https://api.dexto.ai
  • URL
    https://api.dexto.ai/v1/agents/{agent_id}/sessions/{session_id}/cancel
  • Auth
    HTTP bearer

Path parameters

agent_idstring required
session_idstring required

Response

Successful response.

stop_reason'completed' | 'cancelled' | 'spend_limit_reached' | 'insufficient_credits' | 'max_steps' | 'error' nullable required

Why the run stopped, beside its status: completed, cancelled, a reached spend limit, no credits left, the step limit, or any other failure (error).

created_atstring date-time required
idstring uuid required
object'agent_run' required
session_idstring uuid required
status'queued' | 'running' | 'waiting_approval' | 'completed' | 'failed' | 'cancelled' required

Changes

No recorded changes to this operation across all 1 revision of this API.