Skip to content
API Reference
Containers

Retrieve container

client.Containers.Get(ctx, containerID) (*ContainerGetResponse, error)
GET/containers/{container_id}

Retrieve Container

ParametersExpand Collapse
containerID string
ReturnsExpand Collapse
type ContainerGetResponse 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 ContainerGetResponseExpiresAfteroptional

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 ContainerGetResponseMemoryLimitoptional

The memory limit configured for the container.

Accepts one of the following:
const ContainerGetResponseMemoryLimit1g ContainerGetResponseMemoryLimit = "1g"
const ContainerGetResponseMemoryLimit4g ContainerGetResponseMemoryLimit = "4g"
const ContainerGetResponseMemoryLimit16g ContainerGetResponseMemoryLimit = "16g"
const ContainerGetResponseMemoryLimit64g ContainerGetResponseMemoryLimit = "64g"

Retrieve container

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.Get(context.TODO(), "container_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}