Sign in

v4

OpenAPI 3.1.02026-08-01166346466.7 KB
deprecated_vector_stores

[DEPRECATED] Get vector store file

DEPRECATED: Use GET /stores/{store_identifier}/files/{file_id} instead

get/v1/vector_stores/{vector_store_identifier}/files/{file_id}

Path parameters

string required
OR
string uuid required

The ID or name of the vector store

string required
OR
string uuid required

The ID or name of the file

Query parameters

return_chunksboolean

Whether to return the chunks for the file

Whether to return the chunks for the file

Response

The vector store file details

idstring required

Unique identifier for the file

filenamestring

Name of the file

{"stackTrail":"components:schemas:VectorStoreFile:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Optional file metadata","nullable":true}
status'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed'
{"stackTrail":"components:schemas:VectorStoreFile:properties:last_error:anyOf","oasType":"schema","type":"unknown","title":"Last Error","description":"Last error message if processing failed","nullable":true}
vector_store_idstring required

ID of the containing store

created_atstring date-time required

Timestamp of store file creation

versioninteger nullable

Version number of the file

usage_bytesinteger nullable

Storage usage in bytes

object'vector_store.file'

Type of the object

Example response

{
  "version": 1,
  "usage_bytes": 51200,
  "chunks": [
    {
      "mime_type": "text/plain",
      "model": "text-embedding-ada-002",
      "context": "This chunk is from an SEC filing on ACME corp's Q2 2023 performance.",
      "summary": "A short overview of ACME's Q2 2023 performance."
    }
  ]
}