POST/v1/runs/{run_hash}/abort

Abort Run

Stop an active run before completion

This endpoint aborts an active run using its hash ID. The run will stop collecting data and begin the export process for any results already gathered.

Headers

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes

Response Field Explanations

id
string
The aborted run's identifier
Example: 300e9c5c127d421c90f431478d9a2cfb
object
string
Always "run"
Example: run
status
string
Run status (typically "uploading" immediately after abort)
Example: uploading
is_done
boolean
Whether the run has fully completed
Example: true
done_reason
string
Will be "aborted" for manually stopped runs
Example: aborted
total_results
integer
Number of results collected before abort
Example: 6
duration
float
Run duration in seconds before abort
Example: 10.4498
credit_used
float
Credits consumed before abort
Example: 10.4498

Parameters

run_hashstring
Required
The unique identifier (hash) of the run to abort
Example: 300e9c5c127d421c90f431478d9a2cfb
Note

Note

Aborted runs still export any results collected up to the point of abortion.
Warning

Warning

You will still be charged credits for the work done before aborting.
Pro Tip

Pro Tip

Use Get Run Stats to check progress before deciding to abort a run.