Create upload

POSThttps:/api.openai.com/v1/uploads

Creates an intermediate Upload object that you can add Parts 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 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.

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

Request body

  • filename
    string
    Required
    The name of the file to upload.
  • purpose
    string
    Required

    The intended purpose of the uploaded file.

    See the documentation on File purposes.

    • assistants
      string
    • batch
      string
    • fine-tune
      string
    • vision
      string
  • bytes
    integer
    Required
    The number of bytes in the file you are uploading.
  • mime_type
    string
    Required
    The MIME type of the file. This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Response

The Upload object with status pending.

Example request
1
curl https://api.openai.com/v1/uploads \

2
  -H "Authorization: Bearer $OPENAI_API_KEY" \

3
  -d '{

4
    "purpose": "fine-tune",

5
    "filename": "training_examples.jsonl",

6
    "bytes": 2147483648,

7
    "mime_type": "text/jsonl"

8
  }'
Example response
1
{

2
  "id": "upload_abc123",

3
  "object": "upload",

4
  "bytes": 2147483648,

5
  "created_at": 1719184911,

6
  "filename": "training_examples.jsonl",

7
  "purpose": "fine-tune",

8
  "status": "pending",

9
  "expires_at": 1719127296

10
}
Built with