POST
/v1/runs/{run_hash}/abortAbort Run
Stop an active run before completionThis 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
| Key | Value | Required |
|---|---|---|
| Authorization | Token YOUR_API_KEY | Yes |
Response Field Explanations
id
string
Example: 300e9c5c127d421c90f431478d9a2cfb
object
string
Example: run
status
string
Example: uploading
is_done
boolean
Example: true
done_reason
string
Example: aborted
total_results
integer
Example: 6
duration
float
Example: 10.4498
credit_used
float
Example: 10.4498
Parameters
run_hashstring
RequiredExample:
300e9c5c127d421c90f431478d9a2cfbNote
Aborted runs still export any results collected up to the point of abortion.
Warning
You will still be charged credits for the work done before aborting.
Pro Tip
Use Get Run Stats to check progress before deciding to abort a run.