API Reference

Containers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve container

containers.retrieve(container_id) -> ContainerRetrieveResponse { id, created_at, name, 6 more }

GET/containers/{container_id}

Retrieve Container

ParametersExpand Collapse

container_id: String

ReturnsExpand Collapse

class ContainerRetrieveResponse { id, created_at, name, 6 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.

One of the following:

:"1g"

:"4g"

:"16g"

:"64g"

network_policy: { type, allowed_domains}

Network access policy for the container.

type: :allowlist | :disabled

The network policy mode.

One of the following:

:allowlist

:disabled

allowed_domains: Array[String]

Allowed outbound domains when type is allowlist.

Retrieve container

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

require "openai"

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

container = openai.containers.retrieve("container_id")

puts(container)

{
    "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
    "object": "container",
    "created_at": 1747844794,
    "status": "running",
    "expires_after": {
        "anchor": "last_active_at",
        "minutes": 20
    },
    "last_active_at": 1747844794,
    "memory_limit": "4g",
    "name": "My Container"
}

Returns Examples

{
    "id": "cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863",
    "object": "container",
    "created_at": 1747844794,
    "status": "running",
    "expires_after": {
        "anchor": "last_active_at",
        "minutes": 20
    },
    "last_active_at": 1747844794,
    "memory_limit": "4g",
    "name": "My Container"
}