Batch add multiple files to vector store

Adds multiple files to a vector store in a single batch operation.

POST /api/v1/llm/vector_stores/{vector_store_id}/file_batches

Python (SDK)

Python

from mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.vector_stores.create_file_batch(vector_store_id="vs_abc123", file_ids=[
        "file-abc123",
        "file-def456",
        "file-ghi789",
    ], attributes={
        "batch_id": "import-2024-01",
    })

    # Handle response
    print(res)

200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1704067200,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 3,
    "completed": 0,
    "failed": 0,
    "cancelled": 0,
    "total": 3
  }
}

Authorizations

Authorization · string · header · required

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Headers

X-On-Behalf-Of · string

Optional external end-user identifier forwarded by the API gateway.

Path Parameters

vector_store_id · string · required

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

Body

application/json

Request body for creating a vector store file batch.

file_ids · string[]

A list of File IDs that the vector store should use. If attributes or chunking_strategy are provided at the root level, they will be applied to all files in the batch. Mutually exclusive with 'files'.

files · object[]

A list of objects that each include a file_id plus optional attributes or chunking_strategy. Use this when you need to override metadata for specific files. The global attributes or chunking_strategy will be ignored. Mutually exclusive with 'file_ids'.

Show child attributes

attributes · object

Global attributes to apply to all files if using 'file_ids'. Ignored if using 'files'.

Show child attributes

chunking_strategy · object

Global chunking strategy to apply to all files if using 'file_ids'. Ignored if using 'files'.

Option 1

Option 2

Show child attributes

Response

200 - application/json

OK

A batch of files attached to a vector store.

id · string · required

The identifier, which can be referenced in API endpoints.

object · any · required

The object type, which is always 'vector_store.file_batch'.

created_at · integer · required

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

Required range: -9007199254740991 <= x <= 9007199254740991

vector_store_id · string · required

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

status · enum<string> · required

The status of the vector store files batch. 'in_progress' means files are being processed, 'completed' means all files have been processed, 'cancelled' means the batch was cancelled, 'failed' means the batch failed.

Available options: in_progress, completed, cancelled, failed

file_counts · object · required

File processing status counts.

Show child attributes