Skip to content
API Reference
Containers
Files

List container files

containers.files.list(container_id, **kwargs) -> CursorPage<FileListResponse { id, bytes, container_id, 4 more } >
GET/containers/{container_id}/files

List Container files

ParametersExpand Collapse
container_id: String
after: 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: Integer

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

order: :asc | :desc

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

Accepts one of the following:
:asc
:desc
ReturnsExpand Collapse
class FileListResponse { id, bytes, container_id, 4 more }
id: String

Unique identifier for the file.

bytes: Integer

Size of the file in bytes.

container_id: String

The container this file belongs to.

created_at: Integer

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

List container files

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.containers.files.list("container_id")

puts(page)
{
  "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"
}
Returns Examples
{
  "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"
}