Skip to main content
POST
Start a tracking run

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Idempotency-Key
string<uuid>

A UUID chosen by the caller, unique per intended run.

Body

application/json

The body is of type object.

Response

Run started

data
object
required
poll
string
required
Example:

"/api/v1/jobs/<jobId>"