Sign in

v2

latestOpenAPI 3.0.0MITraw.githubusercontent.com2024-10-1794217620.9 KB
Files

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. The Batch API only supports `.jsonl` files up to 100 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). Please [contact us](https://help.openai.com/) if you need to increase these storage limits.

post/files

Response

OK

idstring required

The file identifier, which can be referenced in the API endpoints.

bytesinteger required

The size of the file, in bytes.

created_atinteger required

The Unix timestamp (in seconds) for when the file was created.

filenamestring required

The name of the file.

object'file' required

The object type, which is always file.

purpose'assistants' | 'assistants_output' | 'batch' | 'batch_output' | 'fine-tune' | 'fine-tune-results' | 'vision' required

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

status'uploaded' | 'processed' | 'error' required

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

status_detailsstring

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.