Skip to main content
POST
Preview a build (dry run)

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 overrides for a preview run. When code is omitted the BuildSpec's saved code is previewed; when present it overrides the saved code (validated as base64) for this preview only. sampleSize limits dataset sources only (file sources always pass whole); omit for the default (100 rows), or use a negative value to preview the whole dataset. Ignored for GitPipeline specs' code field, which is fixed to the repo.

code
object
sampleSize
integer

Rows to sample from each dataset source. Omit for the default (100). A negative value previews the whole dataset. Applies to dataset sources only; file sources pass whole.

Example:

100

Response

The created preview 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
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