| Name | Type | Description |
|---|---|---|
description | str | Omit | Default: omitDescription says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary. At most 1024 characters. |
labels | Dict[str, str] | Omit | Default: omit |
run_config | snapshot_create_params.RunConfig | Omit | Default: omit |
tag | str | Omit | Default: omit |
extra_headers | Headers | None | Default: None |
extra_query | Query | None | Default: None |
extra_body | Body | None | Default: None |
timeout | float | httpx.Timeout | None | NotGiven | Default: not_given |
Create a snapshot from a Docker image (async build).
Names use lowercase registry-style components separated by slashes, up to 255 characters. The system/ namespace is read-only.
Labels seed the snapshot's labels, overriding any label of the same key derived from the Docker image.
RunConfig overrides the runtime configuration taken from the Docker image. Every sandbox created from the snapshot runs as the image's USER, in its WORKDIR, with its ENV beneath the sandbox's own env_vars; user and work_dir given here replace the image's, and env_vars merge over it.
mutable Docker-style tag; defaults to "latest"
Send extra headers
Add additional query parameters to the request
Add additional JSON properties to the request
Override the client-level default timeout for this request, in seconds
