---
title: "Create an image build"
method: POST
path: "/api/images/builds"
tags: ["Images"]
---

# Create an image build

`POST /api/images/builds`

## Request body

- CreateImageBuildParams
  - `imageName` string, required — Name for the resulting image. Letters, numbers, dashes, and underscores only.
  - `inputSha256` string, required — SHA-256 of the image archive to upload.
  - `inputSizeBytes` integer, required
  - `inputFormat` 'rootfs_export_tar_gz' — Archive format of the input.
  - `sourcePlatform` 'linux/amd64' — Platform of the source image.
  - `imageConfigUser` string — Default user from the image config.
  - `imageInit` object — Startup defaults to attach to the image.
    - `env` object — Environment variables. Keys must match `^[A-Za-z_][A-Za-z0-9_]*$`.
    - `command` string — Startup command.
    - `args` string[] — Startup argument vector.

## Response `200`

Image build created with a presigned upload target

- CreateImageBuildResponse
  - `build` ImageBuild, required
    - `id` string, uuid, required
    - `imageName` string, required
    - `imageId` string, uuid, nullable
    - `status` 'awaiting_upload' | 'upload_verified' | 'dispatching' | 'building' | 'verifying' | 'completed' | 'failed' | 'canceled', required — Current image-build lifecycle state.
    - `inputSha256` string, nullable
    - `inputSizeBytes` integer, nullable
    - `errorCode` string, nullable
    - `errorMessage` string, nullable
    - `completedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `upload` object, required — Presigned upload target for the image archive.
    - `url` string, required
    - `method` 'PUT', required
    - `headers` object, required
    - `objectKey` string, required
    - `expiresInSeconds` integer, required
    - `maxUploadBytes` integer, required

---

[API](https://skmtc.dev/hyperbrowser/apis/hyperbrowser-api.md) · [All operations](https://skmtc.dev/hyperbrowser/apis/hyperbrowser-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperbrowser/hyperbrowser-api/revisions/9d8b355ebbf2/schema)