Sign in

v4

latestOpenAPI 3.1.02026-08-01166346466.7 KB
stores

Get store file

Get a file from a store.

Args: store_identifier: The ID or name of the store. file_id: The ID or name of the file. options: Get file options.

Returns: VectorStoreFile: The file details.

get/v1/stores/{store_identifier}/files/{file_identifier}

Path parameters

string required
OR
string uuid required

The ID or name of the store

string required
OR
string uuid required

The ID or name of the file

Query parameters

boolean
OR
integer[]

Whether to return the chunks for the file. If a list of integers is provided, only the chunks at the specified indices will be returned.

Response

The store file details

idstring required

Unique identifier for the file

filenamestring

Name of the file

{"stackTrail":"components:schemas:StoreFile:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Optional file metadata","nullable":true}
external_idstring nullable

External identifier for this file in the store

status'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed'
{"stackTrail":"components:schemas:StoreFile:properties:last_error:anyOf","oasType":"schema","type":"unknown","title":"Last Error","description":"Last error message if processing failed","nullable":true}
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

usage_tokensinteger nullable

Storage usage in tokens

object'store.file'

Type of the object

content_urlstring required

Presigned URL for file content

Example response

{
  "version": 1,
  "usage_bytes": 51200,
  "usage_tokens": 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."
    }
  ]
}