Containers

List containers

ContainerListPage containers().list(ContainerListParamsparams = ContainerListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /containers

List Containers

Parameters

ContainerListParams params
- Optional<String> after
  
  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- Optional<Long> limit
  
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- Optional<String> name
  
  Filter results by container name.
- Optional<Order> order
  
  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - ASC("asc")
  - DESC("desc")

Returns

class ContainerListResponse:
- String id
  
  Unique identifier for the container.
- long createdAt
  
  Unix timestamp (in seconds) when the container was created.
- String name
  
  Name of the container.
- String object_
  
  The type of this object.
- String status
  
  Status of the container (e.g., active, deleted).
- Optional<ExpiresAfter> expiresAfter
  
  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.
  - Optional<Anchor> anchor
    
    The reference point for the expiration.
    - LAST_ACTIVE_AT("last_active_at")
  - Optional<Long> minutes
    
    The number of minutes after the anchor before the container expires.
- Optional<Long> lastActiveAt
  
  Unix timestamp (in seconds) when the container was last active.
- Optional<MemoryLimit> memoryLimit
  
  The memory limit configured for the container.
  - _1G("1g")
  - _4G("4g")
  - _16G("16g")
  - _64G("64g")
- Optional<NetworkPolicy> networkPolicy
  
  Network access policy for the container.
  - Type type
    
    The network policy mode.
    - ALLOWLIST("allowlist")
    - DISABLED("disabled")
  - Optional<List<String>> allowedDomains
    
    Allowed outbound domains when type is allowlist.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.ContainerListPage;
import com.openai.models.containers.ContainerListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ContainerListPage page = client.containers().list();
    }
}

Response

{
  "data": [
    {
      "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",
      "network_policy": {
        "type": "allowlist",
        "allowed_domains": [
          "string"
        ]
      }
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Create container

ContainerCreateResponse containers().create(ContainerCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /containers

Create Container

Parameters

ContainerCreateParams params
- String name
  
  Name of the container to create.
- Optional<ExpiresAfter> expiresAfter
  
  Container expiration time in seconds relative to the 'anchor' time.
  - Anchor anchor
    
    Time anchor for the expiration time. Currently only 'last_active_at' is supported.
    - LAST_ACTIVE_AT("last_active_at")
  - long minutes
- Optional<List<String>> fileIds
  
  IDs of files to copy to the container.
- Optional<MemoryLimit> memoryLimit
  
  Optional memory limit for the container. Defaults to "1g".
  - _1G("1g")
  - _4G("4g")
  - _16G("16g")
  - _64G("64g")
- Optional<NetworkPolicy> networkPolicy
  
  Network access policy for the container.
  - class ContainerNetworkPolicyDisabled:
    - JsonValue; type "disabled"constant
      
      Disable outbound network access. Always disabled.
      - DISABLED("disabled")
  - class ContainerNetworkPolicyAllowlist:
    - List<String> allowedDomains
      
      A list of allowed domains when type is allowlist.
    - JsonValue; type "allowlist"constant
      
      Allow outbound network access only to specified domains. Always allowlist.
      - ALLOWLIST("allowlist")
    - Optional<List<ContainerNetworkPolicyDomainSecret>> domainSecrets
      
      Optional domain-scoped secrets for allowlisted domains.
      - String domain
        
        The domain associated with the secret.
      - String name
        
        The name of the secret to inject for the domain.
      - String value
        
        The secret value to inject for the domain.
- Optional<List<Skill>> skills
  
  An optional list of skills referenced by id or inline data.
  - class SkillReference:
    - String skillId
      
      The ID of the referenced skill.
    - JsonValue; type "skill_reference"constant
      
      References a skill created with the /v1/skills endpoint.
      - SKILL_REFERENCE("skill_reference")
    - Optional<String> version
      
      Optional skill version. Use a positive integer or 'latest'. Omit for default.
  - class InlineSkill:
    - String description
      
      The description of the skill.
    - String name
      
      The name of the skill.
    - InlineSkillSource source
      
      Inline skill payload
      - String data
        
        Base64-encoded skill zip bundle.
      - JsonValue; mediaType "application/zip"constant
        
        The media type of the inline skill payload. Must be application/zip.
        
        APPLICATION_ZIP("application/zip")
      - JsonValue; type "base64"constant
        
        The type of the inline skill source. Must be base64.
        
        BASE64("base64")
    - JsonValue; type "inline"constant
      
      Defines an inline skill for this request.
      - INLINE("inline")

Returns

class ContainerCreateResponse:
- String id
  
  Unique identifier for the container.
- long createdAt
  
  Unix timestamp (in seconds) when the container was created.
- String name
  
  Name of the container.
- String object_
  
  The type of this object.
- String status
  
  Status of the container (e.g., active, deleted).
- Optional<ExpiresAfter> expiresAfter
  
  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.
  - Optional<Anchor> anchor
    
    The reference point for the expiration.
    - LAST_ACTIVE_AT("last_active_at")
  - Optional<Long> minutes
    
    The number of minutes after the anchor before the container expires.
- Optional<Long> lastActiveAt
  
  Unix timestamp (in seconds) when the container was last active.
- Optional<MemoryLimit> memoryLimit
  
  The memory limit configured for the container.
  - _1G("1g")
  - _4G("4g")
  - _16G("16g")
  - _64G("64g")
- Optional<NetworkPolicy> networkPolicy
  
  Network access policy for the container.
  - Type type
    
    The network policy mode.
    - ALLOWLIST("allowlist")
    - DISABLED("disabled")
  - Optional<List<String>> allowedDomains
    
    Allowed outbound domains when type is allowlist.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.ContainerCreateParams;
import com.openai.models.containers.ContainerCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ContainerCreateParams params = ContainerCreateParams.builder()
            .name("name")
            .build();
        ContainerCreateResponse container = client.containers().create(params);
    }
}

Response

{
  "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",
  "network_policy": {
    "type": "allowlist",
    "allowed_domains": [
      "string"
    ]
  }
}

Retrieve container

ContainerRetrieveResponse containers().retrieve(ContainerRetrieveParamsparams = ContainerRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}

Retrieve Container

Parameters

ContainerRetrieveParams params
- Optional<String> containerId

Returns

class ContainerRetrieveResponse:
- String id
  
  Unique identifier for the container.
- long createdAt
  
  Unix timestamp (in seconds) when the container was created.
- String name
  
  Name of the container.
- String object_
  
  The type of this object.
- String status
  
  Status of the container (e.g., active, deleted).
- Optional<ExpiresAfter> expiresAfter
  
  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.
  - Optional<Anchor> anchor
    
    The reference point for the expiration.
    - LAST_ACTIVE_AT("last_active_at")
  - Optional<Long> minutes
    
    The number of minutes after the anchor before the container expires.
- Optional<Long> lastActiveAt
  
  Unix timestamp (in seconds) when the container was last active.
- Optional<MemoryLimit> memoryLimit
  
  The memory limit configured for the container.
  - _1G("1g")
  - _4G("4g")
  - _16G("16g")
  - _64G("64g")
- Optional<NetworkPolicy> networkPolicy
  
  Network access policy for the container.
  - Type type
    
    The network policy mode.
    - ALLOWLIST("allowlist")
    - DISABLED("disabled")
  - Optional<List<String>> allowedDomains
    
    Allowed outbound domains when type is allowlist.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.ContainerRetrieveParams;
import com.openai.models.containers.ContainerRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ContainerRetrieveResponse container = client.containers().retrieve("container_id");
    }
}

Response

{
  "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",
  "network_policy": {
    "type": "allowlist",
    "allowed_domains": [
      "string"
    ]
  }
}

Delete a container

containers().delete(ContainerDeleteParamsparams = ContainerDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

delete /containers/{container_id}

Delete Container

Parameters

ContainerDeleteParams params
- Optional<String> containerId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.ContainerDeleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        client.containers().delete("container_id");
    }
}

Files

List container files

FileListPage containers().files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files

List Container files

Parameters

FileListParams params
- Optional<String> containerId
- Optional<String> after
  
  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- Optional<Long> limit
  
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- Optional<Order> order
  
  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - ASC("asc")
  - DESC("desc")

Returns

class FileListResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileListPage;
import com.openai.models.containers.files.FileListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileListPage page = client.containers().files().list("container_id");
    }
}

Response

{
  "data": [
    {
      "id": "id",
      "bytes": 0,
      "container_id": "container_id",
      "created_at": 0,
      "object": "container.file",
      "path": "path",
      "source": "source"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}

Create container file

FileCreateResponse containers().files().create(FileCreateParamsparams = FileCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /containers/{container_id}/files

Create a Container File

You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

Parameters

FileCreateParams params
- Optional<String> containerId
- Optional<String> file
  
  The File object (not file name) to be uploaded.
- Optional<String> fileId
  
  Name of the file to create.

Returns

class FileCreateResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileCreateParams;
import com.openai.models.containers.files.FileCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileCreateResponse file = client.containers().files().create("container_id");
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Retrieve container file

FileRetrieveResponse containers().files().retrieve(FileRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files/{file_id}

Retrieve Container File

Parameters

FileRetrieveParams params
- String containerId
- Optional<String> fileId

Returns

class FileRetrieveResponse:
- String id
  
  Unique identifier for the file.
- long bytes
  
  Size of the file in bytes.
- String containerId
  
  The container this file belongs to.
- long createdAt
  
  Unix timestamp (in seconds) when the file was created.
- JsonValue; object_ "container.file"constant
  
  The type of this object (container.file).
  - CONTAINER_FILE("container.file")
- String path
  
  Path of the file in the container.
- String source
  
  Source of the file (e.g., user, assistant).

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileRetrieveParams;
import com.openai.models.containers.files.FileRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileRetrieveParams params = FileRetrieveParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        FileRetrieveResponse file = client.containers().files().retrieve(params);
    }
}

Response

{
  "id": "id",
  "bytes": 0,
  "container_id": "container_id",
  "created_at": 0,
  "object": "container.file",
  "path": "path",
  "source": "source"
}

Delete a container file

containers().files().delete(FileDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

delete /containers/{container_id}/files/{file_id}

Delete Container File

Parameters

FileDeleteParams params
- String containerId
- Optional<String> fileId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.files.FileDeleteParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        FileDeleteParams params = FileDeleteParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        client.containers().files().delete(params);
    }
}

Content

Retrieve container file content

HttpResponse containers().files().content().retrieve(ContentRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

get /containers/{container_id}/files/{file_id}/content

Retrieve Container File Content

Parameters

ContentRetrieveParams params
- String containerId
- Optional<String> fileId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.http.HttpResponse;
import com.openai.models.containers.files.content.ContentRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ContentRetrieveParams params = ContentRetrieveParams.builder()
            .containerId("container_id")
            .fileId("file_id")
            .build();
        HttpResponse content = client.containers().files().content().retrieve(params);
    }
}

java/resources/containers/index.md +11 −9

6 6

7**get** `/containers`7**get** `/containers`

8 8

~~9List containers~~9List Containers

10 10

11### Parameters11### Parameters

12 12

163 163

164**post** `/containers`164**post** `/containers`

165 165

166Create container166Create Container

167 167

168### Parameters168### Parameters

169 169

423 423

424**get** `/containers/{container_id}`424**get** `/containers/{container_id}`

425 425

426Retrieve container426Retrieve Container

427 427

428### Parameters428### Parameters

429 429

554 554

555**delete** `/containers/{container_id}`555**delete** `/containers/{container_id}`

556 556

557Delete a container557Delete Container

558 558

559### Parameters559### Parameters

560 560

590 590

591**get** `/containers/{container_id}/files`591**get** `/containers/{container_id}/files`

592 592

593List container files593List Container files

594 594

595### Parameters595### Parameters

596 596

697 697

698**post** `/containers/{container_id}/files`698**post** `/containers/{container_id}/files`

699 699

700Create container file700Create a Container File

701

702You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

701 703

702### Parameters704### Parameters

703 705

788 790

789**get** `/containers/{container_id}/files/{file_id}`791**get** `/containers/{container_id}/files/{file_id}`

790 792

791Retrieve container file793Retrieve Container File

792 794

793### Parameters795### Parameters

794 796

877 879

878**delete** `/containers/{container_id}/files/{file_id}`880**delete** `/containers/{container_id}/files/{file_id}`

879 881

880Delete a container file882Delete Container File

881 883

882### Parameters884### Parameters

883 885

919 921

920**get** `/containers/{container_id}/files/{file_id}/content`922**get** `/containers/{container_id}/files/{file_id}/content`

921 923

922Retrieve container file content924Retrieve Container File Content

923 925

924### Parameters926### Parameters

925 927

java/resources/containers/index.md 2026-07-10 23:02 UTC to 2026-07-12 06:58 UTC

Containers

List containers

Parameters

Returns

Example

Response

Create container

Parameters

Returns

Example

Response

Retrieve container

Parameters

Returns

Example

Response

Delete a container

Parameters

Example

Files

List container files

Parameters

Returns

Example

Response

Create container file

Parameters

Returns

Example

Response

Retrieve container file

Parameters

Returns

Example

Response

Delete a container file

Parameters

Example

Content

Retrieve container file content

Parameters

Example