API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Containers

List containers

GET/containers

Create container

POST/containers

Retrieve container

GET/containers/{container_id}

Delete a container

DELETE/containers/{container_id}

ModelsExpand Collapse

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.

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.

One of the following:

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

One of the following:

"allowlist"

"disabled"

allowed_domains: optional array of string

Allowed outbound domains when type is allowlist.

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.

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.

One of the following:

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

One of the following:

"allowlist"

"disabled"

allowed_domains: optional array of string

Allowed outbound domains when type is allowlist.

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.

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.

One of the following:

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

One of the following:

"allowlist"

"disabled"

allowed_domains: optional array of string

Allowed outbound domains when type is allowlist.

ContainersFiles

List container files

GET/containers/{container_id}/files

Create container file

POST/containers/{container_id}/files

Retrieve container file

GET/containers/{container_id}/files/{file_id}

Delete a container file

DELETE/containers/{container_id}/files/{file_id}

ModelsExpand Collapse

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: string

The type of this object (container.file).

path: string

Path of the file in the container.

source: string

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

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: string

The type of this object (container.file).

path: string

Path of the file in the container.

source: string

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

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: string

The type of this object (container.file).

path: string

Path of the file in the container.

source: string

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

ContainersFilesContent

Retrieve container file content

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