OpenAPI::Client::OpenAI::Path::files-file_id(3)

NAME
OpenAPI::Client::OpenAI::Path::files-file_id - Documentation for the /files/{file_id} path.

DESCRIPTION
This document describes the API endpoint at "/files/{file_id}".

PATHS

  "DELETE /files/{file_id}"
Delete a file.

Operation ID

"deleteFile"

    $client->deleteFile( ... );

Parameters

•   "file_id" (in path) (Required) - The ID of the file to use for this request.

    Type: "string"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

  "GET /files/{file_id}"
Returns information about a specific file.

Operation ID

"retrieveFile"

    $client->retrieveFile( ... );

Parameters

•   "file_id" (in path) (Required) - The ID of the file to use for this request.

    Type: "string"

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "id": "file-abc123",
          "object": "file",
          "bytes": 120000,
          "created_at": 1677610602,
          "expires_at": 1680202602,
          "filename": "salesOverview.pdf",
          "purpose": "assistants",
        }

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.