Vector Stores

Search vector store

POST/vector_stores/{vector_store_id}/search

ModelsExpand Collapse

AutoFileChunkingStrategyParam object { type }

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

type: "auto"

Always auto.

FileChunkingStrategyParam = AutoFileChunkingStrategyParam { type } or StaticFileChunkingStrategyObjectParam { static, type }

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

One of the following:

AutoFileChunkingStrategyParam object { type }

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

type: "auto"

Always auto.

StaticFileChunkingStrategyObjectParam object { static, type }

Customize your own chunking strategy by setting chunk size and chunk overlap.

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

type: "static"

Always static.

OtherFileChunkingStrategyObject object { 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.

StaticFileChunkingStrategy object { chunk_overlap_tokens, max_chunk_size_tokens }

chunk_overlap_tokens: number

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: number

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

StaticFileChunkingStrategyObject object { static, type }

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

type: "static"

Always static.

StaticFileChunkingStrategyObjectParam object { static, type }

Customize your own chunking strategy by setting chunk size and chunk overlap.

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

type: "static"

Always static.

VectorStore object { id, created_at, file_counts, 8 more }

A vector store is a collection of processed files can be used by the file_search tool.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

formatunixtime

file_counts: object { cancelled, completed, failed, 2 more }

cancelled: number

The number of files that were cancelled.

completed: number

The number of files that have been successfully processed.

failed: number

The number of files that have failed to process.

in_progress: number

The number of files that are currently being processed.

total: number

The total number of files.

last_active_at: number or null

The Unix timestamp (in seconds) for when the vector store was last active.

formatunixtime

metadata: Metadata or null

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

name: string

The name of the vector store.

object: "vector_store"

The object type, which is always vector_store.

status: "expired" or "in_progress" or "completed"

The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

One of the following:

"expired"

"in_progress"

"completed"

usage_bytes: number

The total number of bytes used by the files in the vector store.

expires_after: optional object { anchor, days }

The expiration policy for a vector store.

anchor: "last_active_at"

Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

days: number

The number of days after the anchor time that the vector store will expire.

minimum1

maximum365

expires_at: optional number or null

The Unix timestamp (in seconds) for when the vector store will expire.

formatunixtime

VectorStoreDeleted object { id, deleted, object }

id: string

deleted: boolean

object: "vector_store.deleted"

VectorStoreSearchResponse object { attributes, content, file_id, 2 more }

attributes: map[string or number or boolean] or null

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

number

boolean

content: array of object { text, type }

Content chunks from the file.

text: string

The text content returned from search.

type: "text"

The type of content.

file_id: string

The ID of the vector store file.

filename: string

The name of the vector store file.

score: number

The similarity score for the result.

minimum0

maximum1

Vector StoresFile Batches

Cancel vector store file batch

POST/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Create vector store file batch

POST/vector_stores/{vector_store_id}/file_batches

List vector store files in a batch

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Retrieve vector store file batch

GET/vector_stores/{vector_store_id}/file_batches/{batch_id}

ModelsExpand Collapse

VectorStoreFileBatch object { id, created_at, file_counts, 3 more }

A batch of files attached to a vector store.

id: string

The identifier, which can be referenced in API endpoints.

created_at: number

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

formatunixtime

file_counts: object { cancelled, completed, failed, 2 more }

cancelled: number

The number of files that where cancelled.

completed: number

The number of files that have been processed.

failed: number

The number of files that have failed to process.

in_progress: number

The number of files that are currently being processed.

total: number

The total number of files.

object: "vector_store.files_batch"

The object type, which is always vector_store.file_batch.

status: "in_progress" or "completed" or "cancelled" or "failed"

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

One of the following:

"in_progress"

"completed"

"cancelled"

"failed"

vector_store_id: string

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

Vector StoresFiles

Retrieve vector store file content

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

Create vector store file

POST/vector_stores/{vector_store_id}/files

Delete vector store file

DELETE/vector_stores/{vector_store_id}/files/{file_id}

List vector store files

GET/vector_stores/{vector_store_id}/files

Retrieve vector store file

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

Update vector store file attributes

POST/vector_stores/{vector_store_id}/files/{file_id}

ModelsExpand Collapse

FileContentResponse object { text, type }

text: optional string

The text content

type: optional string

The content type (currently only "text")

VectorStoreFile object { 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: number

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

formatunixtime

last_error: object { code, message } or null

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

code: "server_error" or "unsupported_file" or "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" or "completed" or "cancelled" or "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: number

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: optional map[string or number or boolean] or null

One of the following:

string

number

boolean

chunking_strategy: optional StaticFileChunkingStrategyObject { static, type } or OtherFileChunkingStrategyObject { type }

The strategy used to chunk the file.

One of the following:

StaticFileChunkingStrategyObject object { static, type }

static: StaticFileChunkingStrategy { chunk_overlap_tokens, max_chunk_size_tokens }

type: "static"

Always static.

OtherFileChunkingStrategyObject object { 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.

VectorStoreFileDeleted object { id, deleted, object }

id: string

deleted: boolean

object: "vector_store.file.deleted"

Suggested

Suggested

Vector Stores

Create vector store

Delete vector store

List vector stores

Retrieve vector store

Search vector store

Modify vector store

ModelsExpand Collapse

Vector StoresFile Batches

Cancel vector store file batch

Create vector store file batch

List vector store files in a batch

Retrieve vector store file batch

ModelsExpand Collapse

Vector StoresFiles

Retrieve vector store file content

Create vector store file

Delete vector store file

List vector store files

Retrieve vector store file

Update vector store file attributes

ModelsExpand Collapse