⋙ Create Vector Store File Batch

Create a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store for which to create a File Batch.

file_ids array

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

⋙ Retrieve Vector Store File Batch

Retrieves a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the file batch belongs to.

batch_id string

The ID of the file batch being retrieved.

⋙ Cancel Vector Store File Batch

Cancel a vector store file batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the file batch belongs to.

batch_id string

The ID of the file batch to cancel.

⋙ List Vector Store Batch Files

Returns a list of vector store files in a batch.

msg.payload Properties

vector_store_id string

The ID of the vector store that the files belong to.

batch_id string

The ID of the file batch that the files belong to.

limit integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order string

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after string

A cursor for use in pagination. after is an object ID that defines your place in the list.

before string

A cursor for use in pagination. before is an object ID that defines your place in the list.

filter string

Filter by file status. One of in_progress, completed, failed, cancelled.

⋙ Upload and Poll File Batch [undocumented]

Uploads the given files concurrently and then creates a vector store file batch.

msg.payload Properties

vector_store_id string

The id of the vector store to which the files are being uploaded.

files array

A list of absolute file paths to the files that are being uploaded.

file_ids array

A list of previously uploaded file ids.