Skip to main content
POST
Start a research run for a project.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

projectId
string
required

Body

application/json

Company scope for the run

Request body for starting a research run

companyId
string
required

Company ID that owns the project

Response

The queued run, or the already-active run

Result of a run trigger. Returns 202 when a new run started, or 200 with started=false when a run was already in progress for this project.

success
boolean

Whether the request succeeded

started
boolean

True if a new run started; false if a run was already active and was returned instead

run
object

The queued (or already-active) run

creditCost
integer

Credits charged for the run. Charged up front and not refunded if the run fails.