Initiate Image Build
Initiate an image build process.
Returns a presigned URL to upload the build context (tar.gz file). After uploading, call /images/build//start to begin the build.
Rate Limit
150 requests per 60 seconds per IP and token.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request model for building or transferring an image.
Image name (e.g., 'myapp'). Required for build-context builds; optional for transfers.
Image tag (e.g., 'v1.0.0'). Required for build-context builds; optional for transfers.
Path to Dockerfile within build context
Existing public image reference, or comma-separated image references, to transfer instead of uploading a build context
Target platform (linux/amd64 or linux/arm64)
linux/amd64, linux/arm64 Team ID if building image in team context
Visibility override to apply when the build completes. INHERIT preserves existing tag visibility or defaults new tags to PRIVATE.
INHERIT, PRIVATE, PUBLIC Set to 'platform' to build an org-less platform image (admins only). Platform builds must set visibility to PUBLIC and cannot set teamId.
platform "platform"Response
Successful Response
- BuildImageResponse
- BulkImageTransferResponse
Response model for initiating image build.
Build ID for tracking
Full image path with user ID
Build IDs for this request. Multiple IDs are returned for comma-separated transfers.
Presigned URL to upload build context (tar.gz)
URL validity in seconds
Effective visibility for the image when the build completes
PRIVATE, PUBLIC