API Reference

Containers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create container

client.Containers.New(ctx, body) (*ContainerNewResponse, error)

POST/containers

Create Container

ParametersExpand Collapse

body ContainerNewParams

Name param.Field[string]

Name of the container to create.

ExpiresAfter param.Field[ContainerNewParamsExpiresAfter]optional

Container expiration time in seconds relative to the 'anchor' time.

Anchor string

Time anchor for the expiration time. Currently only 'last_active_at' is supported.

Minutes int64

FileIDs param.Field[[]string]optional

IDs of files to copy to the container.

MemoryLimit param.Field[ContainerNewParamsMemoryLimit]optional

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

const ContainerNewParamsMemoryLimit1g ContainerNewParamsMemoryLimit = "1g"

const ContainerNewParamsMemoryLimit4g ContainerNewParamsMemoryLimit = "4g"

const ContainerNewParamsMemoryLimit16g ContainerNewParamsMemoryLimit = "16g"

const ContainerNewParamsMemoryLimit64g ContainerNewParamsMemoryLimit = "64g"

ReturnsExpand Collapse

type ContainerNewResponse struct{…}

ID string

Unique identifier for the container.

CreatedAt int64

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).

ExpiresAfter ContainerNewResponseExpiresAfteroptional

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 stringoptional

The reference point for the expiration.

Minutes int64optional

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

LastActiveAt int64optional

Unix timestamp (in seconds) when the container was last active.

MemoryLimit ContainerNewResponseMemoryLimitoptional

The memory limit configured for the container.

Accepts one of the following:

const ContainerNewResponseMemoryLimit1g ContainerNewResponseMemoryLimit = "1g"

const ContainerNewResponseMemoryLimit4g ContainerNewResponseMemoryLimit = "4g"

const ContainerNewResponseMemoryLimit16g ContainerNewResponseMemoryLimit = "16g"

const ContainerNewResponseMemoryLimit64g ContainerNewResponseMemoryLimit = "64g"

Create container

Go

HTTP

TypeScript

Python

Java

Go

Ruby

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  container, err := client.Containers.New(context.TODO(), openai.ContainerNewParams{
    Name: "name",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", container.ID)
}

200 example

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

200 example

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