Skip to content
API Reference
Containers

List containers

containers.list(**kwargs) -> CursorPage<ContainerListResponse { id, created_at, name, 5 more } >
GET/containers

List Containers

ParametersExpand Collapse
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 ContainerListResponse { id, created_at, name, 5 more }
id: String

Unique identifier for the container.

created_at: Integer

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: { 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: :last_active_at

The reference point for the expiration.

minutes: Integer

The number of minutes after the anchor before the container expires.

last_active_at: Integer

Unix timestamp (in seconds) when the container was last active.

memory_limit: :"1g" | :"4g" | :"16g" | :"64g"

The memory limit configured for the container.

Accepts one of the following:
:"1g"
:"4g"
:"16g"
:"64g"

List containers

require "openai"

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

page = openai.containers.list

puts(page)
{
  "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}
Returns Examples
{
  "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}