Get a file

GET/v1/files/{id}

Get a file.

Returns a file's record. With a virtual key, only files uploaded with that key are returned (403 for another key's file); an unknown id is a 404.

Authenticate with a BYOK virtual key or with x-provider and x-api-key; a PLATFORM virtual key is a 400. OpenAI credentials only; any other provider is a 422.

Authorization

AuthorizationBearer <slug>.<secret>
A virtual key's API key (vk-....<secret>), as Authorization: Bearer. What the OpenAI SDK sends from its api_key. Used by the inference endpoints.
orx-virtual-keyheader
A virtual key's API key in the x-virtual-key header, for clients that keep Authorization for something else.
orx-api-keyheader
Direct credentials: the provider's own API key in x-api-key, with the provider named in x-provider (for example openai). On /v1/messages a virtual key is accepted in x-api-key too, which is what the Claude SDK sends.

Path parameters

idstringrequired
the file's VectorAxis id (vxf-...); the provider's file id is accepted too

Headers

x-providerstring
With direct credentials: the provider x-api-key belongs to, for example openai or anthropic (case and dashes are normalised). Not used with a virtual key.

Responses

200application/json

idstring
The VectorAxis file id: vxf- followed by a UUID.
providerstring
The provider the file was uploaded to, for example OPENAI.
filenamestring
The file's name as uploaded.
bytesinteger<int64>
The file's size in bytes, as the provider reported it. Absent when the provider did not report it.
mime_typestring
The file's content type as uploaded, for example application/jsonl.
purposeenum<string>
What the file is for: batch (input for a batch job), fine-tune (training data), assistants (documents for assistants and the Responses API, the default) or vision (an image for chat messages). Absent when the purpose given at upload is none of these.
One of "fine-tune", "batch", "assistants", "vision"
statusenum<string>
The file's state at VectorAxis: uploaded (received and sent to the provider), processing (the provider is processing it), processed (ready) or error (the provider rejected it; see provider_status).
One of "uploaded", "processing", "processed", "error"
provider_statusstring
The file's status as the provider reported it at upload. Absent when the provider reported none.
organizationstring
The organization the file belongs to. Absent for an upload with direct provider credentials and no x-organization.
virtual_key_slugstring
The slug of the virtual key the file was uploaded with (vk-...). Only that key can read, download or delete it. Absent for an upload with direct provider credentials.
created_atstring<date-time>
When the file was uploaded, ISO 8601.
expires_atstring<date-time>
When the file expires at the provider, ISO 8601. Absent when it does not expire.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.