Files

Upload a file to be used across various endpoints, such as Assistant (<2M tokens), Fine-Tuning, and Batch (<100 MB). Total size of your bucket is 100 GB.

post/files

Request

  • Base URL
    https://gateway.obiguard.ai/v1
  • Auth
    none declared

Request body multipart/form-data

filestring binary required

The File object (not file name) to be uploaded.

purpose'assistants' | 'batch' | 'fine-tune' | 'vision' required

The intended purpose of the uploaded file.

Use "assistants" for Assistants and Message files, "vision" for Assistants image file inputs, "batch" for Batch API, and "fine-tune" for Fine-tuning.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.