# Uploads ## Create upload `$ openai uploads create` **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). Returns the Upload object with status `pending`. ### Parameters - `--bytes: number` The number of bytes in the file you are uploading. - `--filename: string` The name of the file to upload. - `--mime-type: string` 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. - `--purpose: "assistants" or "batch" or "fine-tune" or 3 more` The intended purpose of the uploaded file. See the [documentation on File purposes](https://platform.openai.com/docs/api-reference/files/create#files-create-purpose). - `--expires-after: optional object { anchor, seconds }` The expiration policy for a file. By default, files with `purpose=batch` expire after 30 days and all other files are persisted until they are manually deleted. ### Returns - `upload: object { id, bytes, created_at, 6 more }` The Upload object can accept byte chunks in the form of Parts. - `id: string` The Upload unique identifier, which can be referenced in API endpoints. - `bytes: number` The intended number of bytes to be uploaded. - `created_at: number` The Unix timestamp (in seconds) for when the Upload was created. - `expires_at: number` The Unix timestamp (in seconds) for when the Upload will expire. - `filename: string` The name of the file to be uploaded. - `object: "upload"` The object type, which is always "upload". - `purpose: string` The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values. - `status: "pending" or "completed" or "cancelled" or "expired"` The status of the Upload. - `"pending"` - `"completed"` - `"cancelled"` - `"expired"` - `file: optional object { id, bytes, created_at, 6 more }` The `File` object represents a document that has been uploaded to OpenAI. - `id: string` The file identifier, which can be referenced in the API endpoints. - `bytes: number` The size of the file, in bytes. - `created_at: number` The Unix timestamp (in seconds) for when the file was created. - `filename: string` The name of the file. - `object: "file"` The object type, which is always `file`. - `purpose: "assistants" or "assistants_output" or "batch" or 5 more` The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`. - `"assistants"` - `"assistants_output"` - `"batch"` - `"batch_output"` - `"fine-tune"` - `"fine-tune-results"` - `"vision"` - `"user_data"` - `status: "uploaded" or "processed" or "error"` Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. - `"uploaded"` - `"processed"` - `"error"` - `expires_at: optional number` The Unix timestamp (in seconds) for when the file will expire. - `status_details: optional string` Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. ### Example ```cli openai uploads create \ --api-key 'My API Key' \ --bytes 0 \ --filename filename \ --mime-type mime_type \ --purpose assistants ``` #### Response ```json { "id": "id", "bytes": 0, "created_at": 0, "expires_at": 0, "filename": "filename", "object": "upload", "purpose": "purpose", "status": "pending", "file": { "id": "id", "bytes": 0, "created_at": 0, "filename": "filename", "object": "file", "purpose": "assistants", "status": "uploaded", "expires_at": 0, "status_details": "status_details" } } ``` ## Complete upload `$ openai uploads complete` **post** `/uploads/{upload_id}/complete` Completes the [Upload](https://platform.openai.com/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](https://platform.openai.com/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Returns the Upload object with status `completed`, including an additional `file` property containing the created usable File object. ### Parameters - `--upload-id: string` The ID of the Upload. - `--part-id: array of string` The ordered list of Part IDs. - `--md5: optional string` The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect. ### Returns - `upload: object { id, bytes, created_at, 6 more }` The Upload object can accept byte chunks in the form of Parts. - `id: string` The Upload unique identifier, which can be referenced in API endpoints. - `bytes: number` The intended number of bytes to be uploaded. - `created_at: number` The Unix timestamp (in seconds) for when the Upload was created. - `expires_at: number` The Unix timestamp (in seconds) for when the Upload will expire. - `filename: string` The name of the file to be uploaded. - `object: "upload"` The object type, which is always "upload". - `purpose: string` The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values. - `status: "pending" or "completed" or "cancelled" or "expired"` The status of the Upload. - `"pending"` - `"completed"` - `"cancelled"` - `"expired"` - `file: optional object { id, bytes, created_at, 6 more }` The `File` object represents a document that has been uploaded to OpenAI. - `id: string` The file identifier, which can be referenced in the API endpoints. - `bytes: number` The size of the file, in bytes. - `created_at: number` The Unix timestamp (in seconds) for when the file was created. - `filename: string` The name of the file. - `object: "file"` The object type, which is always `file`. - `purpose: "assistants" or "assistants_output" or "batch" or 5 more` The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`. - `"assistants"` - `"assistants_output"` - `"batch"` - `"batch_output"` - `"fine-tune"` - `"fine-tune-results"` - `"vision"` - `"user_data"` - `status: "uploaded" or "processed" or "error"` Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. - `"uploaded"` - `"processed"` - `"error"` - `expires_at: optional number` The Unix timestamp (in seconds) for when the file will expire. - `status_details: optional string` Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. ### Example ```cli openai uploads complete \ --api-key 'My API Key' \ --upload-id upload_abc123 \ --part-id string ``` #### Response ```json { "id": "id", "bytes": 0, "created_at": 0, "expires_at": 0, "filename": "filename", "object": "upload", "purpose": "purpose", "status": "pending", "file": { "id": "id", "bytes": 0, "created_at": 0, "filename": "filename", "object": "file", "purpose": "assistants", "status": "uploaded", "expires_at": 0, "status_details": "status_details" } } ``` ## Cancel upload `$ openai uploads cancel` **post** `/uploads/{upload_id}/cancel` Cancels the Upload. No Parts may be added after an Upload is cancelled. Returns the Upload object with status `cancelled`. ### Parameters - `--upload-id: string` The ID of the Upload. ### Returns - `upload: object { id, bytes, created_at, 6 more }` The Upload object can accept byte chunks in the form of Parts. - `id: string` The Upload unique identifier, which can be referenced in API endpoints. - `bytes: number` The intended number of bytes to be uploaded. - `created_at: number` The Unix timestamp (in seconds) for when the Upload was created. - `expires_at: number` The Unix timestamp (in seconds) for when the Upload will expire. - `filename: string` The name of the file to be uploaded. - `object: "upload"` The object type, which is always "upload". - `purpose: string` The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values. - `status: "pending" or "completed" or "cancelled" or "expired"` The status of the Upload. - `"pending"` - `"completed"` - `"cancelled"` - `"expired"` - `file: optional object { id, bytes, created_at, 6 more }` The `File` object represents a document that has been uploaded to OpenAI. - `id: string` The file identifier, which can be referenced in the API endpoints. - `bytes: number` The size of the file, in bytes. - `created_at: number` The Unix timestamp (in seconds) for when the file was created. - `filename: string` The name of the file. - `object: "file"` The object type, which is always `file`. - `purpose: "assistants" or "assistants_output" or "batch" or 5 more` The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`. - `"assistants"` - `"assistants_output"` - `"batch"` - `"batch_output"` - `"fine-tune"` - `"fine-tune-results"` - `"vision"` - `"user_data"` - `status: "uploaded" or "processed" or "error"` Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. - `"uploaded"` - `"processed"` - `"error"` - `expires_at: optional number` The Unix timestamp (in seconds) for when the file will expire. - `status_details: optional string` Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. ### Example ```cli openai uploads cancel \ --api-key 'My API Key' \ --upload-id upload_abc123 ``` #### Response ```json { "id": "id", "bytes": 0, "created_at": 0, "expires_at": 0, "filename": "filename", "object": "upload", "purpose": "purpose", "status": "pending", "file": { "id": "id", "bytes": 0, "created_at": 0, "filename": "filename", "object": "file", "purpose": "assistants", "status": "uploaded", "expires_at": 0, "status_details": "status_details" } } ``` ## Domain Types ### Upload - `upload: object { id, bytes, created_at, 6 more }` The Upload object can accept byte chunks in the form of Parts. - `id: string` The Upload unique identifier, which can be referenced in API endpoints. - `bytes: number` The intended number of bytes to be uploaded. - `created_at: number` The Unix timestamp (in seconds) for when the Upload was created. - `expires_at: number` The Unix timestamp (in seconds) for when the Upload will expire. - `filename: string` The name of the file to be uploaded. - `object: "upload"` The object type, which is always "upload". - `purpose: string` The intended purpose of the file. [Please refer here](https://platform.openai.com/docs/api-reference/files/object#files/object-purpose) for acceptable values. - `status: "pending" or "completed" or "cancelled" or "expired"` The status of the Upload. - `"pending"` - `"completed"` - `"cancelled"` - `"expired"` - `file: optional object { id, bytes, created_at, 6 more }` The `File` object represents a document that has been uploaded to OpenAI. - `id: string` The file identifier, which can be referenced in the API endpoints. - `bytes: number` The size of the file, in bytes. - `created_at: number` The Unix timestamp (in seconds) for when the file was created. - `filename: string` The name of the file. - `object: "file"` The object type, which is always `file`. - `purpose: "assistants" or "assistants_output" or "batch" or 5 more` The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `vision`, and `user_data`. - `"assistants"` - `"assistants_output"` - `"batch"` - `"batch_output"` - `"fine-tune"` - `"fine-tune-results"` - `"vision"` - `"user_data"` - `status: "uploaded" or "processed" or "error"` Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`. - `"uploaded"` - `"processed"` - `"error"` - `expires_at: optional number` The Unix timestamp (in seconds) for when the file will expire. - `status_details: optional string` Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`. # Parts ## Add upload part `$ openai uploads:parts create` **post** `/uploads/{upload_id}/parts` Adds a [Part](https://platform.openai.com/docs/api-reference/uploads/part-object) to an [Upload](https://platform.openai.com/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](https://platform.openai.com/docs/api-reference/uploads/complete). ### Parameters - `--upload-id: string` The ID of the Upload. - `--data: string` The chunk of bytes for this Part. ### Returns - `upload_part: object { id, created_at, object, upload_id }` The upload Part represents a chunk of bytes we can add to an Upload object. - `id: string` The upload Part unique identifier, which can be referenced in API endpoints. - `created_at: number` The Unix timestamp (in seconds) for when the Part was created. - `object: "upload.part"` The object type, which is always `upload.part`. - `upload_id: string` The ID of the Upload object that this Part was added to. ### Example ```cli openai uploads:parts create \ --api-key 'My API Key' \ --upload-id upload_abc123 \ --data 'Example data' ``` #### Response ```json { "id": "id", "created_at": 0, "object": "upload.part", "upload_id": "upload_id" } ``` ## Domain Types ### Upload Part - `upload_part: object { id, created_at, object, upload_id }` The upload Part represents a chunk of bytes we can add to an Upload object. - `id: string` The upload Part unique identifier, which can be referenced in API endpoints. - `created_at: number` The Unix timestamp (in seconds) for when the Part was created. - `object: "upload.part"` The object type, which is always `upload.part`. - `upload_id: string` The ID of the Upload object that this Part was added to.