Skip to main content
POST
/
cancel
/
{team_id}
/
{run_id}
cURL
curl -X POST \
  -H 'Authorization: Bearer $JWT_TOKEN' \
  -H 'Accept: application/json' \
  '$BASE_URL/cancel/{TEAM_ID}/{RUN_ID}'
{
  "message": "Run successfully canceled."
}

Documentation Index

Fetch the complete documentation index at: https://docs.playbook3d.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

Your API key. This is required by most endpoints to access our API programmatically. You can view your x-api-key using the 'Profile' tab on the website.

​
Authorization
string
required

Bearer token for authentication (JWT).

Path Parameters

​
team_id
string<uuid>
required

The UUID of the team that owns this run.

​
run_id
string<uuid>
required

The UUID of the run to cancel.

Response

The run was canceled successfully or is already in a final state.

​
message
string

A success message, or final run state.