List Stores
List all stores with optional search.
GET
ApiKeyAuthheader
AuthorizationBearer <token>Api key to access Mixedbreads API
limit?LimitMaximum number of items to return per page (1-100)
Range
1 <= value <= 100Default
20after?|Cursor for forward pagination - get items after this position. Use last_cursor from previous response.
before?|Cursor for backward pagination - get items before this position. Use first_cursor from previous response.
include_total?Include TotalWhether to include total count in response (expensive operation)
Default
falseq?|Search query for fuzzy matching over name and description fields
The list of stores
application/json- response
pagination*Response model for cursor-based pagination.
object?ObjectThe object type of the response
Default
"list"data*array<>The list of stores
from mixedbread import Mixedbread
mxbai = Mixedbread(api_key="YOUR_API_KEY")
response = mxbai.stores.list(limit=20)
for store in response.data:
print(store)Example Response
{
"object": "list",
"data": [
{
"id": "vs_abc123",
"object": "store",
"name": "product-documentation",
"description": "Product documentation and FAQs",
"is_public": false,
"metadata": {},
"tags": [],
"config": {
"contextualization": {
"with_metadata": false,
"with_file_context": false
}
},
"file_counts": {
"in_progress": 0,
"completed": 10,
"failed": 0,
"cancelled": 0,
"pending": 0,
"total": 10
},
"status": "completed",
"usage_bytes": 2097152,
"usage_tokens": 102400,
"expires_after": null,
"expires_at": null,
"created_at": "2025-01-10T09:00:00.000Z",
"updated_at": "2025-01-15T11:30:00.000Z",
"last_active_at": "2025-01-15T14:00:00.000Z"
},
{
"id": "vs_def456",
"object": "store",
"name": "api-documentation",
"description": "API reference documentation",
"is_public": true,
"metadata": {},
"tags": [],
"config": {
"contextualization": {
"with_metadata": false,
"with_file_context": false
}
},
"file_counts": {
"in_progress": 0,
"completed": 5,
"failed": 0,
"cancelled": 0,
"pending": 0,
"total": 5
},
"status": "completed",
"usage_bytes": 1048576,
"usage_tokens": 51200,
"expires_after": null,
"expires_at": null,
"created_at": "2025-01-12T10:15:00.000Z",
"updated_at": "2025-01-14T09:20:00.000Z",
"last_active_at": "2025-01-15T13:45:00.000Z"
}
],
"pagination": {
"has_more": false,
"first_cursor": "eyJpZCI6InZzX2FiYzEyMyJ9",
"last_cursor": "eyJpZCI6InZzX2RlZjQ1NiJ9"
}
}