Containers

List containers

get /containers

List containers

Query Parameters

after: optional string

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 number

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

Filter results by container name.
order: optional "asc" or "desc"

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

Returns

data: array of object { id, created_at, name, 6 more }

A list of containers.
- id: string
  
  Unique identifier for the container.
- created_at: number
  
  Unix timestamp (in seconds) when the container was created.
- name: string
  
  Name of the container.
- object: string
  
  The type of this object.
- status: string
  
  Status of the container (e.g., active, deleted).
- expires_after: optional object { anchor, minutes }
  
  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 "last_active_at"
    
    The reference point for the expiration.
    - "last_active_at"
  - minutes: optional number
    
    The number of minutes after the anchor before the container expires.
- last_active_at: optional number
  
  Unix timestamp (in seconds) when the container was last active.
- memory_limit: optional "1g" or "4g" or "16g" or "64g"
  
  The memory limit configured for the container.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: optional object { type, allowed_domains }
  
  Network access policy for the container.
  - type: "allowlist" or "disabled"
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: optional array of string
    
    Allowed outbound domains when type is allowlist.
first_id: string

The ID of the first container in the list.
has_more: boolean

Whether there are more containers available.
last_id: string

The ID of the last container in the list.
object: "list"

The type of object returned, must be 'list'.
- "list"

Example

curl https://api.openai.com/v1/containers \
    -H "Authorization: Bearer $OPENAI_API_KEY"

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"
}

Example

curl https://api.openai.com/v1/containers \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
  "object": "list",
  "data": [
    {
        "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
        "object": "container",
        "created_at": 1747844794,
        "status": "running",
        "expires_after": {
            "anchor": "last_active_at",
            "minutes": 20
        },
        "last_active_at": 1747844794,
        "memory_limit": "4g",
        "name": "My Container"
    }
  ],
  "first_id": "container_123",
  "last_id": "container_123",
  "has_more": false
}

Create container

post /containers

Create container

Body Parameters

name: string

Name of the container to create.
expires_after: optional object { anchor, minutes }

Container expiration time in seconds relative to the 'anchor' time.
- anchor: "last_active_at"
  
  Time anchor for the expiration time. Currently only 'last_active_at' is supported.
  - "last_active_at"
- minutes: number
file_ids: optional array of string

IDs of files to copy to the container.
memory_limit: optional "1g" or "4g" or "16g" or "64g"

Optional memory limit for the container. Defaults to "1g".
- "1g"
- "4g"
- "16g"
- "64g"
network_policy: optional ContainerNetworkPolicyDisabled or ContainerNetworkPolicyAllowlist

Network access policy for the container.
- ContainerNetworkPolicyDisabled object { type }
  - type: "disabled"
    
    Disable outbound network access. Always disabled.
    - "disabled"
- ContainerNetworkPolicyAllowlist object { allowed_domains, type, domain_secrets }
  - allowed_domains: array of string
    
    A list of allowed domains when type is allowlist.
  - type: "allowlist"
    
    Allow outbound network access only to specified domains. Always allowlist.
    - "allowlist"
  - domain_secrets: optional array of ContainerNetworkPolicyDomainSecret
    
    Optional domain-scoped secrets for allowlisted domains.
    - domain: string
      
      The domain associated with the secret.
    - name: string
      
      The name of the secret to inject for the domain.
    - value: string
      
      The secret value to inject for the domain.
skills: optional array of SkillReference or InlineSkill

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

Returns

id: string

Unique identifier for the container.
created_at: number

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

Name of the container.
object: string

The type of this object.
status: string

Status of the container (e.g., active, deleted).
expires_after: optional object { anchor, minutes }

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 "last_active_at"
  
  The reference point for the expiration.
  - "last_active_at"
- minutes: optional number
  
  The number of minutes after the anchor before the container expires.
last_active_at: optional number

Unix timestamp (in seconds) when the container was last active.
memory_limit: optional "1g" or "4g" or "16g" or "64g"

The memory limit configured for the container.
- "1g"
- "4g"
- "16g"
- "64g"
network_policy: optional object { type, allowed_domains }

Network access policy for the container.
- type: "allowlist" or "disabled"
  
  The network policy mode.
  - "allowlist"
  - "disabled"
- allowed_domains: optional array of string
  
  Allowed outbound domains when type is allowlist.

Example

curl https://api.openai.com/v1/containers \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "name": "name"
        }'

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"
    ]
  }
}

Example

curl https://api.openai.com/v1/containers \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "My Container",
        "memory_limit": "4g",
        "skills": [
          {
            "type": "skill_reference",
            "skill_id": "skill_4db6f1a2c9e73508b41f9da06e2c7b5f"
          },
          {
            "type": "skill_reference",
            "skill_id": "openai-spreadsheets",
            "version": "latest"
          }
        ],
        "network_policy": {
          "type": "allowlist",
          "allowed_domains": ["api.buildkite.com"]
        }
      }'

Response

{
    "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"
}

Retrieve container

get /containers/{container_id}

Retrieve container

Path Parameters

container_id: string

Returns

id: string

Unique identifier for the container.
created_at: number

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

Name of the container.
object: string

The type of this object.
status: string

Status of the container (e.g., active, deleted).
expires_after: optional object { anchor, minutes }

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 "last_active_at"
  
  The reference point for the expiration.
  - "last_active_at"
- minutes: optional number
  
  The number of minutes after the anchor before the container expires.
last_active_at: optional number

Unix timestamp (in seconds) when the container was last active.
memory_limit: optional "1g" or "4g" or "16g" or "64g"

The memory limit configured for the container.
- "1g"
- "4g"
- "16g"
- "64g"
network_policy: optional object { type, allowed_domains }

Network access policy for the container.
- type: "allowlist" or "disabled"
  
  The network policy mode.
  - "allowlist"
  - "disabled"
- allowed_domains: optional array of string
  
  Allowed outbound domains when type is allowlist.

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

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"
    ]
  }
}

Example

curl https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
    "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
    "object": "container",
    "created_at": 1747844794,
    "status": "running",
    "expires_after": {
        "anchor": "last_active_at",
        "minutes": 20
    },
    "last_active_at": 1747844794,
    "memory_limit": "4g",
    "name": "My Container"
}

Delete a container

delete /containers/{container_id}

Delete a container

Path Parameters

container_id: string

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID \
    -X DELETE \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Example

curl -X DELETE https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
    "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
    "object": "container.deleted",
    "deleted": true
}

Domain Types

Container List Response

ContainerListResponse object { id, created_at, name, 6 more }
- id: string
  
  Unique identifier for the container.
- created_at: number
  
  Unix timestamp (in seconds) when the container was created.
- name: string
  
  Name of the container.
- object: string
  
  The type of this object.
- status: string
  
  Status of the container (e.g., active, deleted).
- expires_after: optional object { anchor, minutes }
  
  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 "last_active_at"
    
    The reference point for the expiration.
    - "last_active_at"
  - minutes: optional number
    
    The number of minutes after the anchor before the container expires.
- last_active_at: optional number
  
  Unix timestamp (in seconds) when the container was last active.
- memory_limit: optional "1g" or "4g" or "16g" or "64g"
  
  The memory limit configured for the container.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: optional object { type, allowed_domains }
  
  Network access policy for the container.
  - type: "allowlist" or "disabled"
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: optional array of string
    
    Allowed outbound domains when type is allowlist.

Container Create Response

ContainerCreateResponse object { id, created_at, name, 6 more }
- id: string
  
  Unique identifier for the container.
- created_at: number
  
  Unix timestamp (in seconds) when the container was created.
- name: string
  
  Name of the container.
- object: string
  
  The type of this object.
- status: string
  
  Status of the container (e.g., active, deleted).
- expires_after: optional object { anchor, minutes }
  
  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 "last_active_at"
    
    The reference point for the expiration.
    - "last_active_at"
  - minutes: optional number
    
    The number of minutes after the anchor before the container expires.
- last_active_at: optional number
  
  Unix timestamp (in seconds) when the container was last active.
- memory_limit: optional "1g" or "4g" or "16g" or "64g"
  
  The memory limit configured for the container.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: optional object { type, allowed_domains }
  
  Network access policy for the container.
  - type: "allowlist" or "disabled"
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: optional array of string
    
    Allowed outbound domains when type is allowlist.

Container Retrieve Response

ContainerRetrieveResponse object { id, created_at, name, 6 more }
- id: string
  
  Unique identifier for the container.
- created_at: number
  
  Unix timestamp (in seconds) when the container was created.
- name: string
  
  Name of the container.
- object: string
  
  The type of this object.
- status: string
  
  Status of the container (e.g., active, deleted).
- expires_after: optional object { anchor, minutes }
  
  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 "last_active_at"
    
    The reference point for the expiration.
    - "last_active_at"
  - minutes: optional number
    
    The number of minutes after the anchor before the container expires.
- last_active_at: optional number
  
  Unix timestamp (in seconds) when the container was last active.
- memory_limit: optional "1g" or "4g" or "16g" or "64g"
  
  The memory limit configured for the container.
  - "1g"
  - "4g"
  - "16g"
  - "64g"
- network_policy: optional object { type, allowed_domains }
  
  Network access policy for the container.
  - type: "allowlist" or "disabled"
    
    The network policy mode.
    - "allowlist"
    - "disabled"
  - allowed_domains: optional array of string
    
    Allowed outbound domains when type is allowlist.

Files

List container files

get /containers/{container_id}/files

List container files

Path Parameters

container_id: string

Query Parameters

after: optional string

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 number

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

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

Returns

data: array of object { id, bytes, container_id, 4 more }

A list of container files.
- id: string
  
  Unique identifier for the file.
- bytes: number
  
  Size of the file in bytes.
- container_id: string
  
  The container this file belongs to.
- created_at: number
  
  Unix timestamp (in seconds) when the file was created.
- object: "container.file"
  
  The type of this object (container.file).
  - "container.file"
- path: string
  
  Path of the file in the container.
- source: string
  
  Source of the file (e.g., user, assistant).
first_id: string

The ID of the first file in the list.
has_more: boolean

Whether there are more files available.
last_id: string

The ID of the last file in the list.
object: "list"

The type of object returned, must be 'list'.
- "list"

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID/files \
    -H "Authorization: Bearer $OPENAI_API_KEY"

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"
}

Example

curl https://api.openai.com/v1/containers/cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04/files \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
    "object": "list",
    "data": [
        {
            "id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
            "object": "container.file",
            "created_at": 1747848842,
            "bytes": 880,
            "container_id": "cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04",
            "path": "/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json",
            "source": "user"
        }
    ],
    "first_id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
    "has_more": false,
    "last_id": "cfile_682e0e8a43c88191a7978f477a09bdf5"
}

Create container file

post /containers/{container_id}/files

Create container file

Path Parameters

container_id: string

Body Parameters

file: optional string

The File object (not file name) to be uploaded.
file_id: optional string

Name of the file to create.

Returns

id: string

Unique identifier for the file.
bytes: number

Size of the file in bytes.
container_id: string

The container this file belongs to.
created_at: number

Unix timestamp (in seconds) when the file was created.
object: "container.file"

The type of this object (container.file).
- "container.file"
path: string

Path of the file in the container.
source: string

Source of the file (e.g., user, assistant).

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID/files \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

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

Example

curl https://api.openai.com/v1/containers/cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04/files \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -F file="@example.txt"

Response

{
  "id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
  "object": "container.file",
  "created_at": 1747848842,
  "bytes": 880,
  "container_id": "cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04",
  "path": "/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json",
  "source": "user"
}

Retrieve container file

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

Retrieve container file

Path Parameters

container_id: string
file_id: string

Returns

id: string

Unique identifier for the file.
bytes: number

Size of the file in bytes.
container_id: string

The container this file belongs to.
created_at: number

Unix timestamp (in seconds) when the file was created.
object: "container.file"

The type of this object (container.file).
- "container.file"
path: string

Path of the file in the container.
source: string

Source of the file (e.g., user, assistant).

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID/files/$FILE_ID \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

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

Example

curl https://api.openai.com/v1/containers/container_123/files/file_456 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
    "id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
    "object": "container.file",
    "created_at": 1747848842,
    "bytes": 880,
    "container_id": "cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04",
    "path": "/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json",
    "source": "user"
}

Delete a container file

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

Delete a container file

Path Parameters

container_id: string
file_id: string

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID/files/$FILE_ID \
    -X DELETE \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Example

curl -X DELETE https://api.openai.com/v1/containers/cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863/files/cfile_682e0e8a43c88191a7978f477a09bdf5 \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

{
    "id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
    "object": "container.file.deleted",
    "deleted": true
}

Domain Types

File List Response

FileListResponse object { id, bytes, container_id, 4 more }
- id: string
  
  Unique identifier for the file.
- bytes: number
  
  Size of the file in bytes.
- container_id: string
  
  The container this file belongs to.
- created_at: number
  
  Unix timestamp (in seconds) when the file was created.
- object: "container.file"
  
  The type of this object (container.file).
  - "container.file"
- path: string
  
  Path of the file in the container.
- source: string
  
  Source of the file (e.g., user, assistant).

File Create Response

FileCreateResponse object { id, bytes, container_id, 4 more }
- id: string
  
  Unique identifier for the file.
- bytes: number
  
  Size of the file in bytes.
- container_id: string
  
  The container this file belongs to.
- created_at: number
  
  Unix timestamp (in seconds) when the file was created.
- object: "container.file"
  
  The type of this object (container.file).
  - "container.file"
- path: string
  
  Path of the file in the container.
- source: string
  
  Source of the file (e.g., user, assistant).

File Retrieve Response

FileRetrieveResponse object { id, bytes, container_id, 4 more }
- id: string
  
  Unique identifier for the file.
- bytes: number
  
  Size of the file in bytes.
- container_id: string
  
  The container this file belongs to.
- created_at: number
  
  Unix timestamp (in seconds) when the file was created.
- object: "container.file"
  
  The type of this object (container.file).
  - "container.file"
- path: string
  
  Path of the file in the container.
- source: string
  
  Source of the file (e.g., user, assistant).

Content

Retrieve container file content

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

Retrieve container file content

Path Parameters

container_id: string
file_id: string

Example

curl https://api.openai.com/v1/containers/$CONTAINER_ID/files/$FILE_ID/content \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Example

curl https://api.openai.com/v1/containers/container_123/files/cfile_456/content \
  -H "Authorization: Bearer $OPENAI_API_KEY"

Response

<binary content of the file>

resources/containers/index.md +30 −20

4 4

5**get** `/containers`5**get** `/containers`

6 6

~~7List Containers~~7List containers

8 8

9### Query Parameters9### Query Parameters

10 10

196 196

197**post** `/containers`197**post** `/containers`

198 198

199Create Container199Create container

200 200

201### Body Parameters201### Body Parameters

202 202

486 486

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

488 488

489Retrieve Container489Retrieve container

490 490

491### Path Parameters491### Path Parameters

492 492

622 622

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

624 624

625Delete Container625Delete a container

626 626

627### Path Parameters627### Path Parameters

628 628

877 877

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

879 879

880List Container files880List container files

881 881

882### Path Parameters882### Path Parameters

883 883

923 923

924 Unix timestamp (in seconds) when the file was created.924 Unix timestamp (in seconds) when the file was created.

925 925

926 - `object: string`926 - `object: "container.file"`

927 927

928 The type of this object (`container.file`).928 The type of this object (`container.file`).

929 929

930 - `"container.file"`

931

930 - `path: string`932 - `path: string`

931 933

932 Path of the file in the container.934 Path of the file in the container.

970 "bytes": 0,972 "bytes": 0,

971 "container_id": "container_id",973 "container_id": "container_id",

972 "created_at": 0,974 "created_at": 0,

973 "object": "object",975 "object": "container.file",

974 "path": "path",976 "path": "path",

975 "source": "source"977 "source": "source"

976 }978 }

1015 1017

1016**post** `/containers/{container_id}/files`1018**post** `/containers/{container_id}/files`

1017 1019

1018Create a Container File1020Create container file

~~1019~~

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

1021 1021

1022### Path Parameters1022### Path Parameters

1023 1023

1051 1051

1052 Unix timestamp (in seconds) when the file was created.1052 Unix timestamp (in seconds) when the file was created.

1053 1053

1054- `object: string`1054- `object: "container.file"`

1055 1055

1056 The type of this object (`container.file`).1056 The type of this object (`container.file`).

1057 1057

1058 - `"container.file"`

1059

1058- `path: string`1060- `path: string`

1059 1061

1060 Path of the file in the container.1062 Path of the file in the container.

1079 "bytes": 0,1081 "bytes": 0,

1080 "container_id": "container_id",1082 "container_id": "container_id",

1081 "created_at": 0,1083 "created_at": 0,

1082 "object": "object",1084 "object": "container.file",

1083 "path": "path",1085 "path": "path",

1084 "source": "source"1086 "source": "source"

1085}1087}

1111 1113

1112**get** `/containers/{container_id}/files/{file_id}`1114**get** `/containers/{container_id}/files/{file_id}`

1113 1115

1114Retrieve Container File1116Retrieve container file

1115 1117

1116### Path Parameters1118### Path Parameters

1117 1119

1137 1139

1138 Unix timestamp (in seconds) when the file was created.1140 Unix timestamp (in seconds) when the file was created.

1139 1141

1140- `object: string`1142- `object: "container.file"`

1141 1143

1142 The type of this object (`container.file`).1144 The type of this object (`container.file`).

1143 1145

1146 - `"container.file"`

1147

1144- `path: string`1148- `path: string`

1145 1149

1146 Path of the file in the container.1150 Path of the file in the container.

1164 "bytes": 0,1168 "bytes": 0,

1165 "container_id": "container_id",1169 "container_id": "container_id",

1166 "created_at": 0,1170 "created_at": 0,

1167 "object": "object",1171 "object": "container.file",

1168 "path": "path",1172 "path": "path",

1169 "source": "source"1173 "source": "source"

1170}1174}

1195 1199

1196**delete** `/containers/{container_id}/files/{file_id}`1200**delete** `/containers/{container_id}/files/{file_id}`

1197 1201

1198Delete Container File1202Delete a container file

1199 1203

1200### Path Parameters1204### Path Parameters

1201 1205

1250 1254

1251 Unix timestamp (in seconds) when the file was created.1255 Unix timestamp (in seconds) when the file was created.

1252 1256

1253 - `object: string`1257 - `object: "container.file"`

1254 1258

1255 The type of this object (`container.file`).1259 The type of this object (`container.file`).

1256 1260

1261 - `"container.file"`

1262

1257 - `path: string`1263 - `path: string`

1258 1264

1259 Path of the file in the container.1265 Path of the file in the container.

1282 1288

1283 Unix timestamp (in seconds) when the file was created.1289 Unix timestamp (in seconds) when the file was created.

1284 1290

1285 - `object: string`1291 - `object: "container.file"`

1286 1292

1287 The type of this object (`container.file`).1293 The type of this object (`container.file`).

1288 1294

1295 - `"container.file"`

1296

1289 - `path: string`1297 - `path: string`

1290 1298

1291 Path of the file in the container.1299 Path of the file in the container.

1314 1322

1315 Unix timestamp (in seconds) when the file was created.1323 Unix timestamp (in seconds) when the file was created.

1316 1324

1317 - `object: string`1325 - `object: "container.file"`

1318 1326

1319 The type of this object (`container.file`).1327 The type of this object (`container.file`).

1320 1328

1329 - `"container.file"`

1330

1321 - `path: string`1331 - `path: string`

1322 1332

1323 Path of the file in the container.1333 Path of the file in the container.

1332 1342

1333**get** `/containers/{container_id}/files/{file_id}/content`1343**get** `/containers/{container_id}/files/{file_id}/content`

1334 1344

1335Retrieve Container File Content1345Retrieve container file content

1336 1346

1337### Path Parameters1347### Path Parameters

1338 1348

resources/containers/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

Containers

List containers

Query Parameters

Returns

Example

Response

Example

Response

Create container

Body Parameters

Returns

Example

Response

Example

Response

Retrieve container

Path Parameters

Returns

Example

Response

Example

Response

Delete a container

Path Parameters

Example

Example

Response

Domain Types

Container List Response

Container Create Response

Container Retrieve Response

Files

List container files

Path Parameters

Query Parameters

Returns

Example

Response

Example

Response

Create container file

Path Parameters

Body Parameters

Returns

Example

Response

Example

Response

Retrieve container file

Path Parameters

Returns

Example

Response

Example

Response

Delete a container file

Path Parameters

Example

Example

Response

Domain Types

File List Response

File Create Response

File Retrieve Response

Content

Retrieve container file content

Path Parameters

Example

Example

Response