Skip to content
🌕 Lucero

Create a vector store file batch.

POST
/vector_stores/{vector_store_id}/file_batches

Authorizations

Parameters

Path Parameters

vector_store_id
required
string
vs_abc123

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

Request Body required

object
file_ids
required

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

Array<string>
>= 1 items <= 500 items
chunking_strategy
One of:

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

object
type
required

Always auto.

string
Allowed values: auto

Responses

200

OK

A batch of files attached to a vector store.

object
id
required

The identifier, which can be referenced in API endpoints.

string
object
required

The object type, which is always vector_store.file_batch.

string
Allowed values: vector_store.files_batch
created_at
required

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

integer
vector_store_id
required

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

string
status
required

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

string
Allowed values: in_progress completed cancelled failed
file_counts
required
object
in_progress
required

The number of files that are currently being processed.

integer
completed
required

The number of files that have been processed.

integer
failed
required

The number of files that have failed to process.

integer
cancelled
required

The number of files that where cancelled.

integer
total
required

The total number of files.

integer