Skip to content
API Reference
Containers

Create container

client.containers.create(ContainerCreateParams { name, expires_after, file_ids, memory_limit } body, RequestOptionsoptions?): ContainerCreateResponse { id, created_at, name, 5 more }
POST/containers

Create Container

ParametersExpand Collapse
body: ContainerCreateParams { name, expires_after, file_ids, memory_limit }
name: string

Name of the container to create.

expires_after?: ExpiresAfter

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?: 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
ContainerCreateResponse { id, created_at, name, 5 more }
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?: ExpiresAfter { 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?: number

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

last_active_at?: number

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

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const container = await client.containers.create({ name: 'name' });

console.log(container.id);
{
  "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"
}