Retrieve File

GET /files/{file_id}

cURL

cURL

curl https://api.portkey.ai/v1/files/file-abc123 \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY"

200

{
  "id": "<string>",
  "bytes": 123,
  "created_at": 123,
  "filename": "<string>",
  "status_details": "<string>"
}

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NamePortkey-Key & ConfigPortkey-Key & Provider-Auth & Provider-Name & Custom-Host

x-portkey-api-key · string · header · required

x-portkey-virtual-key · string · header · required

Path Parameters

file_id · string · required

The ID of the file to use for this request.

Response

200 - application/json

OK

The File object represents a document that has been uploaded to OpenAI.

id · string · required

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

bytes · integer · required

The size of the file, in bytes.

created_at · integer · required

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

filename · string · required

The name of the file.

object · enum<string> · required

The object type, which is always file.

Available options: file

purpose · enum<string> · required

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

Available options: assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision

status · enum<string> · required · deprecated

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

Available options: uploaded, processed, error

status_details · string · deprecated

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