Docs
Sign in

Start a live preview of a branch Koidog produced.

A task's branch (taskId), or a managed crew's integration branch (crewId alone).

POST/api/v1/previews

Scopecrews

Starts or reuses a cloud VM under the crew's budget and limits, so it can cost money. Asking again for the same commit answers the same preview. When an API key calls it, the timeline records who did what and the outcome. No path or query parameters.

Headers.

Idempotency-Keystring

Makes a retry safe: the same key with the same request returns the first answer and does nothing else.

Body.

crewIdstringrequired

The crew whose branch to preview. At least 5 characters.

taskIdstring

Preview this task's branch. Absent: the crew's integration branch (managed crews). At least 5 characters.

accessenum

private: the URL carries an access token. public: no token; it needs an approval first. Default private.

ttlMinutes5–240

Koidog stops it after this long. Default 30.

Response.

201 Created: a Preview. The example has placeholder values.

409
Refused with 409 and the reason when it cannot run (no preview command on the project, cloud not connected, a Mac-only crew, the budget).
422 validation_failed
The body does not match its schema; each problem is in details.