Sign in
blueprints

Create a blueprint and start its build.

The build runs asynchronously. Poll the blueprint until its status reaches build_complete.

post/blueprints

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/blueprints
  • Auth: none declared. Required headers: x-organization-id

Headers

x-organization-idstring required

Active organization id (or slug). Required for org-scoped operations; the generated client enforces it at compile time.

Request body

namestring required
dockerfilestring required
userMode'root' | 'user' required
resourceSize'SMALL' | 'MEDIUM' | 'LARGE' | 'X_LARGE' | 'XX_LARGE'
repoSlugstring
repoAccess'connected' | 'public'
repoBranchstring
installCommandstring
systemSetupCommandsstring[]
launchCommandsstring[]
baseBlueprintNamestring
fileMountsobject
buildArgsobject
isBaseboolean
architecture'x86_64' | 'arm64'

Response

Response

idstring required
namestring required
status'queued' | 'provisioning' | 'building' | 'failed' | 'build_complete' required
createTimeMsnumber required
buildFinishTimeMsnumber
metadataobject
failureReasonstring
dockerfilestring
resourceSize'SMALL' | 'MEDIUM' | 'LARGE' | 'X_LARGE' | 'XX_LARGE'
systemSetupCommandsstring[]
launchCommandsstring[]
baseBlueprintNamestring
fileMountsobject
installCommandstring
repoBranchstring
buildArgsobject
architecture'x86_64' | 'arm64'

Changes

No recorded changes to this operation across all 50 revisions of this API.