API Reference

Vector Stores

Files

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve vector store file

vector_stores.files.retrieve(file_id, **kwargs) -> VectorStoreFile { id, created_at, last_error, 6 more }

GET/vector_stores/{vector_store_id}/files/{file_id}

Retrieves a vector store file.

ParametersExpand Collapse

vector_store_id: String

file_id: String

ReturnsExpand Collapse

class VectorStoreFile { id, created_at, last_error, 6 more }

A list of files attached to a vector store.

id: String

The identifier, which can be referenced in API endpoints.

created_at: Integer

The Unix timestamp (in seconds) for when the vector store file was created.

last_error: { code, message}

The last error associated with this vector store file. Will be null if there are no errors.

code: :server_error | :unsupported_file | :invalid_file

One of server_error, unsupported_file, or invalid_file.

One of the following:

:server_error

:unsupported_file

:invalid_file

message: String

A human-readable description of the error.

object: :"vector_store.file"

The object type, which is always vector_store.file.

status: :in_progress | :completed | :cancelled | :failed

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.

One of the following:

:in_progress

:completed

:cancelled

:failed

usage_bytes: Integer

The total vector store usage in bytes. Note that this may be different from the original file size.

vector_store_id: String

The ID of the vector store that the File is attached to.

attributes: Hash[Symbol, String | Float | bool]

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.

One of the following:

String

Float

bool

chunking_strategy: FileChunkingStrategy

The strategy used to chunk the file.

One of the following:

class StaticFileChunkingStrategyObject { static, type }

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

chunk_overlap_tokens: Integer

The number of tokens that overlap between chunks. The default value is 400.

Note that the overlap must not exceed half of max_chunk_size_tokens.

max_chunk_size_tokens: Integer

The maximum number of tokens in each chunk. The default value is 800. The minimum value is 100 and the maximum value is 4096.

minimum100

maximum4096

type: :static

Always static.

class OtherFileChunkingStrategyObject { type }

This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.

type: :other

Always other.

Retrieve vector store file

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

vector_store_file = openai.vector_stores.files.retrieve("file-abc123", vector_store_id: "vs_abc123")

puts(vector_store_file)

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null
}

Returns Examples

{
  "id": "file-abc123",
  "object": "vector_store.file",
  "created_at": 1699061776,
  "vector_store_id": "vs_abcd",
  "status": "completed",
  "last_error": null
}