Skip to main content
POST
Create an image build

Authorizations

x-api-key
string
header
required

Body

application/json
imageName
string
required

Name for the resulting image. Letters, numbers, dashes, and underscores only.

Maximum string length: 64
Pattern: ^[A-Za-z0-9_-]+$
inputSha256
string
required

SHA-256 of the image archive to upload.

Required string length: 64
Pattern: ^[A-Fa-f0-9]{64}$
inputSizeBytes
integer
required
Required range: x >= 1
inputFormat
enum<string>
default:rootfs_export_tar_gz

Input archive or manifest format. GPU publication requires dockerfile_context_tar_gz or dockerfile_context_manifest_v1. Use the CLI to package the context and manage uploads.

Available options:
rootfs_export_tar_gz,
dockerfile_context_tar_gz,
dockerfile_context_manifest_v1,
docker_image_manifest_v1
sourcePlatform
enum<string>
default:linux/amd64

Platform of the source image.

Available options:
linux/amd64
imageConfigUser
string

Default user from the image config.

imageInit
object

Startup defaults to attach to the image.

enableGPUBuilds
boolean
default:false

Also publish an image for GPU sandboxes. Requires GPU access and a Dockerfile context input format. GPUs are attached only when a sandbox runs, not during image builds. Wait for gpuImageReady before GPU creation.

dockerfilePath
string
default:Dockerfile

Dockerfile path relative to the build context for remote Dockerfile builds.

contextManifest
object

Build context manifest for dockerfile_context_manifest_v1. Generated by the CLI when packaging a remote build context.

dockerImageManifest
object

Docker image manifest for docker_image_manifest_v1. Generated by the CLI for local Docker image exports. This format does not support GPU publication.

Response

200 - application/json

Image build created with a presigned upload target

build
object
required
upload
object
required

Presigned upload target for the image archive.