OpenAPI::Client::OpenAI::Path::uploads(3)

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

DESCRIPTION
This document describes the API endpoint at "/uploads".

PATHS

  "POST /uploads"
Creates an intermediate Upload <https://platform.openai.com/docs/api-reference/uploads/object> object that you can add Parts <https://platform.openai.com/docs/api-reference/uploads/part-object> to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File <https://platform.openai.com/docs/api-reference/files/object> object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain "purpose" values, the correct "mime_type" must be specified. Please refer to documentation for the supported MIME types for your use case <https://platform.openai.com/docs/assistants/tools/file-search#supported-files>.

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File <https://platform.openai.com/docs/api-reference/files/create>.

Operation ID

"createUpload"

    $client->createUpload( ... );

Parameters

Request Body

Content Type: "application/json"

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": "upload_abc123",
          "object": "upload",
          "bytes": 2147483648,
          "created_at": 1719184911,
          "filename": "training_examples.jsonl",
          "purpose": "fine-tune",
          "status": "completed",
          "expires_at": 1719127296,
          "file": {
            "id": "file-xyz321",
            "object": "file",
            "bytes": 2147483648,
            "created_at": 1719186911,
            "filename": "training_examples.jsonl",
            "purpose": "fine-tune",
          }
        }

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.