Image helpers

See Import a Docker image and Build a Docker image for complete programs. These helpers use the same connection sources as the sandbox factory. A supplied client, cache, or store remains owned by the caller. Import and build sandbox images with managed clients and persistent caches. Each helper returns a ConTree image UUID for create_sandbox_session. Connection settings follow the sandbox factory. Supplied clients and stores remain caller-owned; helpers close only the resources they create.

`image_cache_directory()`

def contree_sdk.images.image_cache_directory(cache_dir) -> Path

Select the image store directory without creating it.

default:"None"

Path

The explicit directory or $XDG_CACHE_HOME/contree (default ~/.cache/contree).

`sync_import_image()`

def contree_sdk.images.sync_import_image(source, *, tag, timeout, no_cache, store, cache_dir, cache_ttl, url, project, token, auth_type, profile, config_path, client, client_type, **client_kwargs) -> str

Import a registry image and wait for a usable filesystem image. Registry names such as alpine:latest and docker:// URLs are accepted. Pass ImageImportRegistry for registry credentials. Results are cached for one hour by default. no_cache=True imports again and refreshes the cached result. A requested tag is reapplied on cache hits. Timeout or interruption after submission requests cancellation of the import operation. Import failure or a missing result image raises FailedOperationError.

required

default:"None"

default:"300"

default:"False"

default:"None"

default:"3600"

default:"None"

str

The imported ConTree image UUID.

TypeError – A supplied component uses the wrong execution mode.

ValueError – The source, timeout, TTL, or connection settings are invalid.

`async_import_image()`

async def contree_sdk.images.async_import_image(source, *, tag, timeout, no_cache, store, cache_dir, cache_ttl, url, project, token, auth_type, profile, config_path, client, client_type, **client_kwargs) -> str

required

default:"None"

default:"300"

default:"False"

default:"None"

default:"3600"

default:"None"

str

The imported ConTree image UUID.

TypeError – A supplied component uses the wrong execution mode.

ValueError – The source, timeout, TTL, or connection settings are invalid.

`sync_build_image()`

def contree_sdk.images.sync_build_image(context, *, dockerfile, tag, build_args, no_cache, timeout, session_id, store, cache_dir, on_event, on_step, builder_type, builder_kwargs, url, project, token, auth_type, profile, config_path, client, client_type, **client_kwargs) -> str

Build a Dockerfile with persistent layer history and upload caching. The default Dockerfile is context/Dockerfile. A SQLite store in the XDG cache directory holds history and reusable results unless supplied explicitly. no_cache=True disables layer reuse; content-addressed uploads remain cached. Use builder_type and builder_kwargs to extend the existing Docker builder. The connection scope is part of the default build session identity. Invalid inputs raise ValueError; failed build steps raise DockerBuildError.

required

default:"None"

default:"False"

default:"600"

default:"None"

str

The built ConTree filesystem image UUID.

TypeError – A supplied component uses the wrong execution mode.

`async_build_image()`

async def contree_sdk.images.async_build_image(context, *, dockerfile, tag, build_args, no_cache, timeout, session_id, store, cache_dir, on_event, on_step, builder_type, builder_kwargs, url, project, token, auth_type, profile, config_path, client, client_type, **client_kwargs) -> str

required

default:"None"

default:"False"

default:"600"

default:"None"

str

The built ConTree filesystem image UUID.

TypeError – A supplied component uses the wrong execution mode.

Get Started

Inference

Observability

Post-training

Data Lab

Sandboxes

Teams & Access Management

Other Capabilities

Integrations

Platform Notices

`image_cache_directory()`

`sync_import_image()`

`async_import_image()`

`sync_build_image()`

`async_build_image()`

​image_cache_directory()

​sync_import_image()

​async_import_image()

​sync_build_image()

​async_build_image()

`image_cache_directory()`

`sync_import_image()`

`async_import_image()`

`sync_build_image()`

`async_build_image()`