Skip to content
API Reference
Containers

Retrieve container

client.containers.retrieve(stringcontainerID, RequestOptionsoptions?): ContainerRetrieveResponse { id, created_at, name, 5 more }
GET/containers/{container_id}

Retrieve Container

ParametersExpand Collapse
containerID: string
ReturnsExpand Collapse
ContainerRetrieveResponse { 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"

Retrieve 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.retrieve('container_id');

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"
}