Skip to main content
POST
Cancel a run

Path Parameters

run_id
string<uuid>
required

UUID of the run to cancel. Identifier of a run

Response

Cancel request accepted

agent_name
string
required

A unique identifier for the agent following the RFC 1123 DNS label naming convention.

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
Example:

"chat"

run_id
string<uuid>
required

Identifier of a run

status
enum<string>
required

Status of the run

Available options:
created,
in-progress,
awaiting,
cancelling,
cancelled,
completed,
failed
output
object[]
required
created_at
string<date-time>
required
session_id
string<uuid>

Identifier of a session

await_request
object | null

Payload describing what is awaited from the client to continue the run.

error
object | null
finished_at
string<date-time>