Skip to content

Create container

POST/containers

Create Container

Body ParametersJSONExpand Collapse
name: string

Name of the container to create.

expires_after: optional object { 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: number
file_ids: optional array of string

IDs of files to copy to the container.

memory_limit: optional "1g" or "4g" or "16g" or "64g"

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

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

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

Create container

curl https://api.openai.com/v1/containers \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "name": "name"
        }'
{
  "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"
}