NAME

OpenAPI::Client::OpenAI::Path::containers-container_id-files - Documentation for the /containers/{container_id}/files path.

DESCRIPTION

This document describes the API endpoint at /containers/{container_id}/files.

PATHS

GET /containers/{container_id}/files

List container files

List Container files

Operation ID

ListContainerFiles

$client->ListContainerFiles( ... );

Parameters

• container_id (in path) (Required) -

  Type: string

• 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\": \"cfile_682e0e8a43c88191a7978f477a09bdf5\",\n    \"object\": \"container.file\",\n    \"created_at\": 1747848842,\n    \"bytes\": 880,\n    \"container_id\": \"cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04\",\n    \"path\": \"/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json\",\n    \"source\": \"user\"\n}\n"
     ]
  }

POST /containers/{container_id}/files

Create container file

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.

Operation ID

CreateContainerFile

$client->CreateContainerFile( ... );

Parameters

• container_id (in path) (Required) -

  Type: string

Request Body

Content Type: multipart/form-data

Responses

Status Code: 200

Success

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
      "id": "cfile_682e0e8a43c88191a7978f477a09bdf5",
      "object": "container.file",
      "created_at": 1747848842,
      "bytes": 880,
      "container_id": "cntr_682e0e7318108198aa783fd921ff305e08e78805b9fdbb04",
      "path": "/mnt/data/88e12fa445d32636f190a0b33daed6cb-tsconfig.json",
      "source": "user"
  }

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.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI