Containers

List containers

containers.list(ContainerListParams**kwargs) -> SyncCursorPage[ContainerListResponse]

get /containers

List Containers

Parameters

after: Optional[str]

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
limit: Optional[int]

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
name: Optional[str]

Filter results by container name.
order: Optional[Literal["asc", "desc"]]

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
- "asc"
- "desc"

Returns

class ContainerListResponse: …
- 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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
page = client.containers.list()
page = page.data[0]
print(page.id)

Response

{
  "data": [
    {
      "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",
      "network_policy": {
        "type": "allowlist",
        "allowed_domains": [
          "string"
        ]
      }
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Create container

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

post /containers

Create Container

Parameters

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.
  - "last_active_at"
- minutes: int
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".
- "1g"
- "4g"
- "16g"
- "64g"
network_policy: Optional[NetworkPolicy]

Network access policy for the container.
- class ContainerNetworkPolicyDisabled: …
  - type: Literal["disabled"]
    
    Disable outbound network access. Always disabled.
    - "disabled"
- class ContainerNetworkPolicyAllowlist: …
  - allowed_domains: List[str]
    
    A list of allowed domains when type is allowlist.
  - type: Literal["allowlist"]
    
    Allow outbound network access only to specified domains. Always allowlist.
    - "allowlist"
  - domain_secrets: Optional[List[ContainerNetworkPolicyDomainSecret]]
    
    Optional domain-scoped secrets for allowlisted domains.
    - domain: str
      
      The domain associated with the secret.
    - name: str
      
      The name of the secret to inject for the domain.
    - value: str
      
      The secret value to inject for the domain.
skills: Optional[Iterable[Skill]]

An optional list of skills referenced by id or inline data.
- class SkillReference: …
  - skill_id: str
    
    The ID of the referenced skill.
  - type: Literal["skill_reference"]
    
    References a skill created with the /v1/skills endpoint.
    - "skill_reference"
  - version: Optional[str]
    
    Optional skill version. Use a positive integer or 'latest'. Omit for default.
- class InlineSkill: …
  - description: str
    
    The description of the skill.
  - name: str
    
    The name of the skill.
  - source: InlineSkillSource
    
    Inline skill payload
    - data: str
      
      Base64-encoded skill zip bundle.
    - media_type: Literal["application/zip"]
      
      The media type of the inline skill payload. Must be application/zip.
      - "application/zip"
    - type: Literal["base64"]
      
      The type of the inline skill source. Must be base64.
      - "base64"
  - type: Literal["inline"]
    
    Defines an inline skill for this request.
    - "inline"

Returns

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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Example

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)

Response

{
  "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",
  "network_policy": {
    "type": "allowlist",
    "allowed_domains": [
      "string"
    ]
  }
}

Retrieve container

containers.retrieve(strcontainer_id) -> ContainerRetrieveResponse

get /containers/{container_id}

Retrieve Container

Parameters

container_id: str

Returns

class ContainerRetrieveResponse: …
- 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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Example

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.retrieve(
    "container_id",
)
print(container.id)

Response

{
  "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",
  "network_policy": {
    "type": "allowlist",
    "allowed_domains": [
      "string"
    ]
  }
}

Delete a container

containers.delete(strcontainer_id)

delete /containers/{container_id}

Delete Container

Parameters

container_id: str

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
client.containers.delete(
    "container_id",
)

Domain Types

Container List Response

class ContainerListResponse: …
- 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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Container Create Response

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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Container Retrieve Response

class ContainerRetrieveResponse: …
- 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.
    - "last_active_at"
  - 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.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: Optional[NetworkPolicy]
  
  Network access policy for the container.
  - type: Literal["allowlist", "disabled"]
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: Optional[List[str]]
    
    Allowed outbound domains when type is allowlist.

Files

List container files

containers.files.list(strcontainer_id, FileListParams**kwargs) -> SyncCursorPage[FileListResponse]

get /containers/{container_id}/files

List Container files

Parameters

container_id: str
after: Optional[str]

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
limit: Optional[int]

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
order: Optional[Literal["asc", "desc"]]

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
- "asc"
- "desc"

Returns

class FileListResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
page = client.containers.files.list(
    container_id="container_id",
)
page = page.data[0]
print(page.id)

Response

{
  "data": [
    {
      "id": "id",
      "bytes": 0,
      "container_id": "container_id",
      "created_at": 0,
      "object": "container.file",
      "path": "path",
      "source": "source"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Create container file

containers.files.create(strcontainer_id, FileCreateParams**kwargs) -> FileCreateResponse

post /containers/{container_id}/files

Create a Container File

You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

Parameters

container_id: str
file: Optional[FileTypes]

The File object (not file name) to be uploaded.
file_id: Optional[str]

Name of the file to create.

Returns

class FileCreateResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

Example

import os
from openai import OpenAI

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

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Retrieve container file

containers.files.retrieve(strfile_id, FileRetrieveParams**kwargs) -> FileRetrieveResponse

get /containers/{container_id}/files/{file_id}

Retrieve Container File

Parameters

container_id: str
file_id: str

Returns

class FileRetrieveResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
file = client.containers.files.retrieve(
    file_id="file_id",
    container_id="container_id",
)
print(file.id)

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Delete a container file

containers.files.delete(strfile_id, FileDeleteParams**kwargs)

delete /containers/{container_id}/files/{file_id}

Delete Container File

Parameters

container_id: str
file_id: str

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
client.containers.files.delete(
    file_id="file_id",
    container_id="container_id",
)

Domain Types

File List Response

class FileListResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

File Create Response

class FileCreateResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

File Retrieve Response

class FileRetrieveResponse: …
- id: str
  
  Unique identifier for the file.
- bytes: int
  
  Size of the file in bytes.
- container_id: str
  
  The container this file belongs to.
- created_at: int
  
  Unix timestamp (in seconds) when the file was created.
- object: Literal["container.file"]
  
  The type of this object (container.file).
  - "container.file"
- path: str
  
  Path of the file in the container.
- source: str
  
  Source of the file (e.g., user, assistant).

Content

Retrieve container file content

containers.files.content.retrieve(strfile_id, ContentRetrieveParams**kwargs) -> BinaryResponseContent

get /containers/{container_id}/files/{file_id}/content

Retrieve Container File Content

Parameters

container_id: str
file_id: str

Returns

BinaryResponseContent

Example

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
content = client.containers.files.content.retrieve(
    file_id="file_id",
    container_id="container_id",
)
print(content)
data = content.read()
print(data)

python/resources/containers/index.md +11 −9

6 6

7**get** `/containers`7**get** `/containers`

8 8

~~9List containers~~9List Containers

10 10

11### Parameters11### Parameters

12 12

154 154

155**post** `/containers`155**post** `/containers`

156 156

157Create container157Create Container

158 158

159### Parameters159### Parameters

160 160

403 403

404**get** `/containers/{container_id}`404**get** `/containers/{container_id}`

405 405

406Retrieve container406Retrieve Container

407 407

408### Parameters408### Parameters

409 409

526 526

527**delete** `/containers/{container_id}`527**delete** `/containers/{container_id}`

528 528

529Delete a container529Delete Container

530 530

531### Parameters531### Parameters

532 532

772 772

773**get** `/containers/{container_id}/files`773**get** `/containers/{container_id}/files`

774 774

775List container files775List Container files

776 776

777### Parameters777### Parameters

778 778

872 872

873**post** `/containers/{container_id}/files`873**post** `/containers/{container_id}/files`

874 874

875Create container file875Create a Container File

876

877You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

876 878

877### Parameters879### Parameters

878 880

955 957

956**get** `/containers/{container_id}/files/{file_id}`958**get** `/containers/{container_id}/files/{file_id}`

957 959

958Retrieve container file960Retrieve Container File

959 961

960### Parameters962### Parameters

961 963

1033 1035

1034**delete** `/containers/{container_id}/files/{file_id}`1036**delete** `/containers/{container_id}/files/{file_id}`

1035 1037

1036Delete a container file1038Delete Container File

1037 1039

1038### Parameters1040### Parameters

1039 1041

1168 1170

1169**get** `/containers/{container_id}/files/{file_id}/content`1171**get** `/containers/{container_id}/files/{file_id}/content`

1170 1172

1171Retrieve container file content1173Retrieve Container File Content

1172 1174

1173### Parameters1175### Parameters

1174 1176

python/resources/containers/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Containers

List containers

Parameters

Returns

Example

Response

Create container

Parameters

Returns

Example

Response

Retrieve container

Parameters

Returns

Example

Response

Delete a container

Parameters

Example

Domain Types

Container List Response

Container Create Response

Container Retrieve Response

Files

List container files

Parameters

Returns

Example

Response

Create container file

Parameters

Returns

Example

Response

Retrieve container file

Parameters

Returns

Example

Response

Delete a container file

Parameters

Example

Domain Types

File List Response

File Create Response

File Retrieve Response

Content

Retrieve container file content

Parameters

Returns

Example