Skip to content
API Reference
Containers

Create container

containers.create(**kwargs) -> ContainerCreateResponse { id, created_at, name, 5 more }
POST/containers

Create Container

ParametersExpand Collapse
name: String

Name of the container to create.

expires_after: { 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.

minutes: Integer
file_ids: Array[String]

IDs of files to copy to the container.

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

Optional memory limit for the container. Defaults to "1g".

Accepts one of the following:
:"1g"
:"4g"
:"16g"
:"64g"
ReturnsExpand Collapse
class ContainerCreateResponse { 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"

Create container

require "openai"

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

container = openai.containers.create(name: "name")

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