List Stores

GET/v1/stores

Authorization

Authorizationstringrequired

Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Query Parameters

limitintegerdefault: 20

Maximum number of items to return per page (1-100)

Constraints

•Minimum: 1•Maximum: 100

afterstring

Cursor for forward pagination - get items after this position. Use last_cursor from previous response.

beforestring

Cursor for backward pagination - get items before this position. Use first_cursor from previous response.

include_totalbooleandefault: false

Whether to include total count in response (expensive operation)

qstring

Search query for fuzzy matching over name and description fields

Response Body

objectstringdefault: list

The object type of the response

Request

GET/v1/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)

Response

JSON

{
  "object": "list",
  "data": [
    {
      "id": "vs_abc123",
      "object": "store",
      "name": "product-documentation",
      "description": "Product documentation and FAQs",
      "is_public": false,
      "metadata": {},
      "file_counts": {
        "in_progress": 0,
        "completed": 10,
        "failed": 0,
        "cancelled": 0,
        "pending": 0,
        "total": 10
      },
      "status": "completed",
      "usage_bytes": 2097152,
      "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": {},
      "file_counts": {
        "in_progress": 0,
        "completed": 5,
        "failed": 0,
        "cancelled": 0,
        "pending": 0,
        "total": 5
      },
      "status": "completed",
      "usage_bytes": 1048576,
      "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"
  }
}