List files in a batch

Retrieves a paginated list of all files within a specific batch operation.

GET /api/v1/llm/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Python (SDK)

Python

from mka1 import SDK


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

    res = sdk.llm.vector_stores.list_files_in_batch(vector_store_id="vs_abc123", batch_id="vsfb_abc123", limit=20, order="desc", after="file-abc123", filter_="completed")

    # Handle response
    print(res)

200

{
  "object": "list",
  "data": [
    {
      "id": "file-abc123",
      "object": "vector_store.file",
      "usage_bytes": 256000,
      "created_at": 1704067200,
      "vector_store_id": "vs_abc123",
      "status": "completed",
      "last_error": null,
      "chunking_strategy": {
        "type": "auto"
      },
      "attributes": {
        "category": "manual",
        "version": "2.0"
      }
    }
  ],
  "first_id": "file-abc123",
  "last_id": "file-abc123",
  "has_more": false
}

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 that the files belong to.

batch_id · string · required

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

Query Parameters

limit · integer · default: 20

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

Required range: 1 <= x <= 100

order · enum<string> · default: desc

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

Available options: asc, desc

after · string

A cursor for use in pagination. An object ID that defines your place in the list for fetching the next page.

before · string

A cursor for use in pagination. An object ID that defines your place in the list for fetching the previous page.

filter · enum<string>

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

Available options: in_progress, completed, failed, cancelled

Response

200 - application/json

OK

A list of vector store files.

object · any · required

The object type, which is always 'list'.

data · object[] · required

Array of vector store file objects.

Show child attributes

first_id · string · required

The ID of the first object in the list.

last_id · string · required

The ID of the last object in the list.

has_more · boolean · required

Whether there are more objects available.