API Reference

Containers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create container

containers.create(ContainerCreateParams**kwargs) -> ContainerCreateResponse

POST/containers

Create Container

ParametersExpand Collapse

name: str

Name of the container to create.

expires_after: Optional[ExpiresAfter]

Container expiration time in seconds relative to the ‘anchor’ time.

file_ids: Optional[Sequence[str]]

IDs of files to copy to the container.

memory_limit: Optional[Literal["1g", "4g", "16g", "64g"]]

Optional memory limit for the container. Defaults to “1g”.

network_policy: Optional[NetworkPolicy]

Network access policy for the container.

skills: Optional[Iterable[Skill]]

An optional list of skills referenced by id or inline data.

ReturnsExpand Collapse

class ContainerCreateResponse: …

id: str

Unique identifier for the container.

created_at: int

Unix timestamp (in seconds) when the container was created.

formatunixtime

name: str

Name of the container.

object: str

The type of this object.

status: str

Status of the container (e.g., active, deleted).

expires_after: Optional[ExpiresAfter]

The container will expire after this time period. The anchor is the reference point for the expiration. The minutes is the number of minutes after the anchor before the container expires.

last_active_at: Optional[int]

Unix timestamp (in seconds) when the container was last active.

formatunixtime

memory_limit: Optional[Literal["1g", "4g", "16g", "64g"]]

The memory limit configured for the container.

network_policy: Optional[NetworkPolicy]

Network access policy for the container.

Create container

Python

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
container = client.containers.create(
    name="name",
)
print(container.id)

{
    "id": "cntr_682e30645a488191b6363a0cbefc0f0a025ec61b66250591",
    "object": "container",
    "created_at": 1747857508,
    "status": "running",
    "expires_after": {
        "anchor": "last_active_at",
        "minutes": 20
    },
    "last_active_at": 1747857508,
    "network_policy": {
        "type": "allowlist",
        "allowed_domains": ["api.buildkite.com"]
    },
    "memory_limit": "4g",
    "name": "My Container"
}

Returns Examples

{
    "id": "cntr_682e30645a488191b6363a0cbefc0f0a025ec61b66250591",
    "object": "container",
    "created_at": 1747857508,
    "status": "running",
    "expires_after": {
        "anchor": "last_active_at",
        "minutes": 20
    },
    "last_active_at": 1747857508,
    "network_policy": {
        "type": "allowlist",
        "allowed_domains": ["api.buildkite.com"]
    },
    "memory_limit": "4g",
    "name": "My Container"
}