Abort Worker Run

Method: POST

Endpoint: /api/v2/worker-runs/{runId}/abort

Authentication: Supports Authorization: Bearer <YOUR_API_KEY>, api-key: <YOUR_API_KEY>, and ?token=<YOUR_API_KEY>. Prefer Bearer token.

Try it

POST/api/v2/worker-runs/{runId}/abortAbort worker run

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

Parameters

runIdpath · stringRequired

Run slug returned as `data.run_slug` from start or rerun responses.

Request BodyNot applicable

No JSON request body. Fill the path or query parameters above.

Send Request Clear all

When to use this endpoint

Use this endpoint to abort an abortable run. Confirm the target before calling it.

Identifier Notes

• runId is the run slug. Use data.run_slug from start or rerun responses as the runId.

Path Parameters

Parameter	Required	Type	Description
runId	Yes	string	Run slug returned as data.run_slug from start or rerun responses.

Request Example

curl -X POST "https://openapi.coreclaw.com/api/v2/worker-runs/YOUR_RUN_ID/abort" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "code": 0,
  "message": "success",
  "request_id": "req-123"
}

Notes

• API v2 supports Bearer token, the legacy api-key header, and query token. Prefer Bearer token for new integrations.

HTTP Responses

HTTP Status	Application Code	Meaning
200	0	OK
400	11000	Bad Request
401	12001	Unauthorized
404	11004	Not Found
422	11000	Unprocessable Entity
429	13000	Too Many Requests
500	10000	Internal Server Error