Skip to main content
Cancel a running or pending flow execution. Useful for aborting long-running jobs or stopping mistakenly triggered executions.

Endpoint

Authentication

Requires an API key with executions:cancel scope.

Path Parameters

Request Body

No request body required. Send an empty POST request.

Response

Success (200 OK)

Response Fields

Examples

cURL

TypeScript

With Timeout Handling

Errors

Error Examples

Already Cancelled:
Not Cancellable (completed):

Cancellation Behavior

Cancelling a running execution may not be immediate. The execution will be cancelled at the next processing checkpoint. Some credits may be charged for work already completed.

Use Cases

User-Initiated Cancellation

Allow users to cancel their own uploads:

Cleanup on Shutdown

Cancel pending executions during graceful shutdown:

Next Steps

Get Execution

Check execution status

Run Flow

Start a new execution