Skip to main content
POST
Schedule a build (create a BuildRun)

Authorizations

Authorization
string
header
required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Path Parameters

buildSpecId
string<uuid>
required

Body

application/json

Optional settings for a build run.

keepOldDataset
boolean
default:true

When true (default), each destination dataset this run replaces is kept, renamed with a -superseded-<epochMillis> suffix. When false, the replaced dataset is deleted right after its replacement is successfully ingested.

Optional entity resolution configuration, run on each output once every output of the run is ingested. When omitted, no entity resolution runs.

Response

The created BuildRun.

id
string<uuid>
required
buildSpecId
string<uuid>
required
specVersion
integer
required

The BuildSpec version this run executes (snapshotted at schedule time).

status
enum<string>
required
Available options:
Scheduled,
Exporting,
Claimable,
Running,
Produced,
Ingesting,
Finished,
Failed
kind
enum<string>
required

Whether this run ingests its output (Build) or presents it to the user (Preview).

Available options:
Build,
Preview
retries
integer
required
keepOldDataset
boolean
required

Whether datasets replaced by this run's outputs are kept (renamed as superseded) rather than deleted once their replacement is ingested.

createdAt
string<date-time>
required

Timestamp of the BuildRun creation.

Example:

"2005-04-02T19:37:00.000Z"

updatedAt
string<date-time>
required

Timestamp of the BuildRun last update.

Example:

"2005-04-02T19:37:00.000Z"

errorMessage
string