Skip to main content

synth_ai.sdk.containers

Hosted Containers SDK — create, manage, and reference hosted containers by ID. Access via SynthClient().containers.

Classes

ContainerType

Supported hosted container types.

ContainerSpec

Specification for creating a hosted container.

Container

Response model for a hosted container.

ContainersClient

Create and manage hosted environment containers. Methods:

create

create(self, spec: ContainerSpec) -> Container
Provision a new hosted container from a :class:ContainerSpec.

get

get(self, container_id: str) -> Container
Retrieve a container by id.

list

list(self) -> builtins.list[Container]
List containers in the current organization.

delete

delete(self, container_id: str) -> None
Delete a hosted container by id.

wait_ready

wait_ready(self, container_id: str) -> Container
Poll until the container reaches ‘ready’ status or a terminal state.

AsyncContainersClient

Async adapter over :class:ContainersClient (thread-offloaded).