OBobiguard
Files

Returns information about a specific file.

get/files/{file_id}

Request

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

Path parameters

file_idstring required

The ID of the file to use for this request.

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.