For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • POSTCancel a batch execution
      • POSTSubmit a batch flow execution
      • GETGet batch execution status
      • GETGet batch summary
      • GETGet per-record cost for a batch
      • GETGet step results for a batch record
      • GETGet batch execution total cost
      • GETWebSocket for real-time batch updates
Dashboard
LogoLogo
Runtype APIBatch

Cancel a batch execution

POST
/v1/batch/cancel/:id
POST
/v1/batch/cancel/:id
$curl -X POST https://api.runtype.com/v1/batch/cancel/id \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "message": "Batch execution 9f8c7d6a-1234-4b56-8e9f-0a1b2c3d4e5f has been successfully cancelled.",
3  "success": true
4}
Cancels a running or queued batch execution.
Was this page helpful?
Previous

Submit a batch flow execution

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired
Batch execution ID

Response

Batch cancelled
messagestring
successboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error