Skip to main content
POST
Cancel research run by ID

Authorizations

X-API-Key
string
header
required

API key for authentication. Get your key from the API Keys page.

Path Parameters

research_run_id
string
required

Research run identifier

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Cancellation outcome

research_run_id
string
required

Research run identifier

status
enum<string>
required

Status of the run after this request

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELLED,
TIMED_OUT
Example:

"CANCELLED"

cancelled
boolean
required

Whether this request changed the run to CANCELLED

Example:

true