API Reference

Stop a run

View Markdown

POST /api/runs/{id}/stop

Gracefully stops a running or pending task run and marks it as completed.

Operation IDstopRun

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Run stopped

Run stopped

Content typeapplication/json

responseobject

1 property

successboolean

Error responses

400Run cannot be stopped

Run cannot be stopped

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/runs/YOUR_ID/stop' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/runs/YOUR_ID/stop", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);