Request durable-run cancellation
curl --request POST \
--url https://api.praxa.io/v1/runs/{id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.praxa.io/v1/runs/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/runs/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"apiVersion": "v1",
"run_id": "018f0000-0000-7000-8000-000000000001",
"requestId": "request-id-demo-0001",
"mode": "task",
"status": "queued",
"createdAt": "2026-08-13T12:00:00.000Z",
"updatedAt": "2026-08-13T12:00:00.000Z",
"links": {
"self": "/v1/runs/018f0000-0000-7000-8000-000000000001",
"events": "/v1/runs/018f0000-0000-7000-8000-000000000001/events"
}
}
Tasks, runs & usage
Request durable-run cancellation
Request cancellation of a durable Praxa run and reconcile the run until it reaches an authoritative terminal outcome.
POST
/
v1
/
runs
/
{id}
/
cancel
Request durable-run cancellation
curl --request POST \
--url https://api.praxa.io/v1/runs/{id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.praxa.io/v1/runs/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/runs/{id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"apiVersion": "v1",
"run_id": "018f0000-0000-7000-8000-000000000001",
"requestId": "request-id-demo-0001",
"mode": "task",
"status": "queued",
"createdAt": "2026-08-13T12:00:00.000Z",
"updatedAt": "2026-08-13T12:00:00.000Z",
"links": {
"self": "/v1/runs/018f0000-0000-7000-8000-000000000001",
"events": "/v1/runs/018f0000-0000-7000-8000-000000000001/events"
}
}
Request cancellation of a durable Praxa run and reconcile the run until it reaches an authoritative terminal outcome.
Availability: Production partner preview. Required scope:
runs:write.Authenticate safely
Create a disposable personal workspace API key with exactlyruns:write. Send it as Authorization: Bearer $PRAXA_API_KEY. A Gateway OAuth token, Supabase JWT, provider credential, or organization memory key is not interchangeable with this key.
The hosted playground sends the credential from your browser session to the documented API through the configured playground proxy. Use test data, never share the key, and revoke it when the check ends.
Request fields
string
required
id path parameter.
Runnable request examples
curl --fail-with-body -X POST 'https://api.praxa.io/v1/runs/018f0000-0000-7000-8000-000000000001/cancel' \
-H "Authorization: Bearer $PRAXA_API_KEY" \
-H "Content-Type: application/json" \
--data '{}'
const response = await fetch("https://api.praxa.io/v1/runs/018f0000-0000-7000-8000-000000000001/cancel", {
"method": "POST",
"headers": {
"Authorization": `Bearer ${process.env.PRAXA_API_KEY}`,
"Content-Type": "application/json"
},
"body": JSON.stringify({})
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text ? JSON.parse(text) : { status: response.status });
import json
import os
from urllib import error, request
payload = json.dumps({}).encode()
req = request.Request(
"https://api.praxa.io/v1/runs/018f0000-0000-7000-8000-000000000001/cancel",
method="POST",
headers={
"Authorization": f"Bearer {os.environ['PRAXA_API_KEY']}",
"Content-Type": "application/json"
},
data=payload,
)
try:
with request.urlopen(req, timeout=30) as response:
text = response.read().decode()
print(json.loads(text) if text else {"status": response.status})
except error.HTTPError as exc:
raise RuntimeError(f"{exc.code}: {exc.read().decode()}") from exc
What success means
A200 response acknowledges the cancellation request and returns a run projection; it does not imply rollback or immediate cancellation.
Successful response
200 — Updated run projection. Acceptance does not imply rollback or an immediate cancelled state. Internal cancelling and reconcile_required states both map to running until the run reaches a terminal outcome.v1
required
apiVersion response field.
string
required
run_id response field.
string
required
requestId response field.
task
required
mode response field.
queued | running | awaiting_approval | completed | failed | cancelled
required
Public lifecycle status. Internal cancelling and reconcile_required states project as running; reconciliation is not terminal.
string
required
createdAt response field.
string
required
updatedAt response field.
string
completedAt response field.
object
Present only when Praxa can derive the exact recorded browser action and bind it to the stored action digest. The summary contains the exact recorded instruction or steps followed by the target host.
object
Present only for schema-valid, digest-matched verified text.
object
failure response field.
object
required
links response field.
{
"apiVersion": "v1",
"run_id": "018f0000-0000-7000-8000-000000000001",
"requestId": "request-id-demo-0001",
"mode": "task",
"status": "queued",
"createdAt": "2026-08-13T12:00:00.000Z",
"updatedAt": "2026-08-13T12:00:00.000Z",
"links": {
"self": "/v1/runs/018f0000-0000-7000-8000-000000000001",
"events": "/v1/runs/018f0000-0000-7000-8000-000000000001/events"
}
}
Handle failures
| Response | Meaning | Safe action |
|---|---|---|
400 invalid_request | The method, path, headers, query, or body failed strict validation. | Correct the request; do not retry unchanged input. |
401 authentication_failed | The bearer key is missing, malformed, expired, or revoked. | Stop and replace the key through the authenticated console. |
403 authorization_failed | The authenticated key lacks scope or tenant authority. | Request only the missing least-privilege scope; never substitute another tenant ID. |
429 rate_limited | The principal exceeded a bounded rate. | Honor retryAfterMs or Retry-After, add jitter, and cap attempts. |
retryable 5xx | The server could not confirm a final response. | Reconcile reads or replay the exact keyed mutation before creating new work. |
Example problem
{
"type": "https://docs.praxa.io/problems/authorization-failed",
"title": "Authorization failed",
"status": 403,
"code": "authorization_failed",
"detail": "The API key does not grant the required scope.",
"retryable": false
}
Verify the result
- Confirm the returned run ID matches the target.
- Continue run or event readback until terminal.
- Do not report cancellation while the projection remains running.
Retry, cleanup, and production use
- Treat
401,403, and409as authority or state signals, not generic retry prompts. - For
429or retryable 5xx responses, follow server retry guidance and keep a bounded attempt budget. - Move the request into a trusted application backend before production; never ship the Praxa key in browser or mobile code.
- Revoke the disposable key, disable test webhooks, and erase disposable candidate data after validation.
Last modified on August 14, 2026