Skip to content
Get started

Images

List images
client.images.list(RequestOptionsoptions?): ImageListResponse { created_at, digest, name, 8 more }
get/images
Pull and convert OCI image
client.images.create(ImageCreateParams { name } body, RequestOptionsoptions?): Image { created_at, digest, name, 8 more }
post/images
Get image details
client.images.get(stringname, RequestOptionsoptions?): Image { created_at, digest, name, 8 more }
get/images/{name}
Delete image
client.images.delete(stringname, RequestOptionsoptions?): void
delete/images/{name}
ModelsExpand Collapse
Image { created_at, digest, name, 8 more }
created_at: string

Creation timestamp (RFC3339)

formatdate-time
digest: string

Resolved manifest digest

name: string

Normalized OCI image reference (tag or digest)

status: "pending" | "pulling" | "converting" | 2 more

Build status

Accepts one of the following:
"pending"
"pulling"
"converting"
"ready"
"failed"
cmd?: Array<string> | null

CMD from container metadata

entrypoint?: Array<string> | null

Entrypoint from container metadata

env?: Record<string, string>

Environment variables from container metadata

error?: string | null

Error message if status is failed

queue_position?: number | null

Position in build queue (null if not queued)

size_bytes?: number | null

Disk size in bytes (null until ready)

formatint64
working_dir?: string | null

Working directory from container metadata