Sample - OpenAI API
GET/vector_stores/{vector_store_id}/files/{file_id}

Retrieve a vector store file

Retrieves a file attached to a vector store. Use vector_store_id and file_id together to identify the association whose ingestion status and metadata you need. The response includes the file's current processing status and any recorded error.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
vector_store_idstringrequired
The identifier of the vector store that contains the file.
file_idstringrequired
The identifier of the file to retrieve from the vector store.

2 status codes
200Returns the vector store file with its identifier, vector store association, usage in bytes, creation timestamp, processing status, last error, chunking strategy, and attributes.
idstringrequired
The identifier, which can be referenced in API endpoints.
objectstringrequired
The object type, which is always `vector_store.file`.
Allowed:vector_store.file
usage_bytesintegerrequired
The total vector store usage in bytes. Note that this may be different from the original file size.
created_atintegerrequired
The Unix timestamp (in seconds) for when the vector store file was created.
vector_store_idstringrequired
The ID of the [vector store](https://developers.openai.com/api/reference/resources/vector_stores) that the [File](https://developers.openai.com/api/reference/resources/files) is attached to.
statusstringrequired
The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.
Allowed:in_progresscompletedcancelledfailed
last_errorobjectrequired
The last error associated with this vector store file. Will be `null` if there are no errors.
chunking_strategyobjectoptional
The strategy used to chunk the file.
attributesobjectoptional
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
429Returned when the request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

vector_store_id and file_id must identify the vector store-file association to retrieve. A 429 is returned when the request exceeds the rate limit.