API ReferenceOpen AI Batch

Retrieve a file

Retrieve metadata for a file from the upstream OpenAI Files API.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Path parameters

file_idstringRequired
OpenAI file ID.

Query parameters

provider_idstringRequired

Provider route with customer-owned credentials, for example openai or parasail.

Response

File details.
idstring
File ID.
objectstring
bytesintegerOptional
File size in bytes.
created_atintegerOptional
Unix timestamp.
filenamestringOptional
purposestringOptional
statusstringOptional
File status.
status_detailsany or nullOptional
Provider status details, when available.

Errors

401
Unauthorized Error
404
Not Found Error