Skip to content
API Reference
Containers

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.

anchor: Literal["last_active_at"]

Time anchor for the expiration time. Currently only 'last_active_at' is supported.

minutes: int
file_ids: Optional[SequenceNotStr[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".

Accepts one of the following:
"1g"
"4g"
"16g"
"64g"
ReturnsExpand Collapse
class ContainerCreateResponse: …
id: str

Unique identifier for the container.

created_at: int

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

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.

anchor: Optional[Literal["last_active_at"]]

The reference point for the expiration.

minutes: Optional[int]

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.

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

The memory limit configured for the container.

Accepts one of the following:
"1g"
"4g"
"16g"
"64g"

Create container

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": "id",
  "created_at": 0,
  "name": "name",
  "object": "object",
  "status": "status",
  "expires_after": {
    "anchor": "last_active_at",
    "minutes": 0
  },
  "last_active_at": 0,
  "memory_limit": "1g"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "name": "name",
  "object": "object",
  "status": "status",
  "expires_after": {
    "anchor": "last_active_at",
    "minutes": 0
  },
  "last_active_at": 0,
  "memory_limit": "1g"
}