API Reference

Containers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

List container files

client.containers.files.list(stringcontainerID, FileListParams { after, limit, order } query?, RequestOptionsoptions?): CursorPage<FileListResponse { id, bytes, container_id, 4 more } >

GET/containers/{container_id}/files

Create container file

client.containers.files.create(stringcontainerID, FileCreateParams { file, file_id } body, RequestOptionsoptions?): FileCreateResponse { id, bytes, container_id, 4 more }

POST/containers/{container_id}/files

Retrieve container file

client.containers.files.retrieve(stringfileID, FileRetrieveParams { container_id } params, RequestOptionsoptions?): FileRetrieveResponse { id, bytes, container_id, 4 more }

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

Delete a container file

client.containers.files.delete(stringfileID, FileDeleteParams { container_id } params, RequestOptionsoptions?): void

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

ModelsExpand Collapse

FileListResponse { 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).

path: string

Path of the file in the container.

source: string

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

FileCreateResponse { 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).

path: string

Path of the file in the container.

source: string

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

FileRetrieveResponse { 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).

path: string

Path of the file in the container.

source: string

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

FilesContent

Retrieve container file content

client.containers.files.content.retrieve(stringfileID, ContentRetrieveParams { container_id } params, RequestOptionsoptions?): Response

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