/ 
OpenAPI-Client-OpenAI-0.24
River stage one • 1 direct dependent • 1 total dependent
⭐ Starred 7 GitHub stars
/ OpenAPI::Client::OpenAI::Path::containers

NAME

OpenAPI::Client::OpenAI::Path::containers - Documentation for the /containers path.

DESCRIPTION

This document describes the API endpoint at /containers.

PATHS

GET /containers

List containers

List Containers

Operation ID

ListContainers

$client->ListContainers( ... );

Parameters

  • limit (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: integer

    Default: 20

  • order (in query) (Optional) - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

    Type: string

    Allowed values: asc, desc

    Default: desc

  • after (in query) (Optional) - 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.

    Type: string

Responses

Status Code: 200

Success

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

    {
   "data" : [
      "{\n   \"id\": \"cntr_682dfebaacac8198bbfe9c2474fb6f4a085685cbe3cb5863\",\n   \"object\": \"container\",\n   \"created_at\": 1747844794,\n   \"status\": \"running\",\n   \"expires_after\": {\n     \"anchor\": \"last_active_at\",\n     \"minutes\": 20\n   },\n   \"last_active_at\": 1747844794,\n   \"name\": \"My Container\"\n}\n"
   ]
}

POST /containers

Create container

Create Container

Operation ID

CreateContainer

$client->CreateContainer( ... );

Parameters

Request Body

Content Type: application/json

Example:

{
   "expires_after" : null,
   "file_ids" : [
      null
   ]
}

Responses

Status Code: 200

Success

Content Types:

  • application/json

    Example (See the OpenAI spec for more detail):

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

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.