MImixedbread
stores

List stores

Changed on

List all stores with optional search and tag filter.

Args: options: The pagination options, search query and tag filter.

Returns: StoreListResponse: The list of stores.

get/v1/stores

Request

  • Base URL
    https://api.mixedbread.com
  • URL
    https://api.mixedbread.com/v1/stores
  • Auth
    HTTP bearer

Query parameters

limitinteger

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

Example:10
afterstring nullable

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

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==
beforestring nullable

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

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==
include_totalboolean

Whether to include total count in response (expensive operation)

qstring nullable

Search query for fuzzy matching over name and description fields

tagsstring[] nullable

Only return stores that carry every one of these tags

Response

The list of stores

object'list'

The object type of the response

Example response

{
  "pagination": {
    "has_more": true,
    "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==",
    "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==",
    "total": 42
  },
  "data": [
    {
      "id": "1b8b486e-16d0-400b-8868-04cd75217a7e",
      "name": "customer-support-kb",
      "description": "Contains customer support articles and FAQs",
      "metadata": {
        "category": "support",
        "language": "en"
      },
      "tags": [
        "production",
        "docs"
      ],
      "file_counts": {
        "pending": 5,
        "in_progress": 5,
        "cancelled": 2,
        "completed": 42,
        "failed": 1,
        "total": 50
      },
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "usage_bytes": 1024000,
      "usage_tokens": 1024000,
      "expires_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Changes

  • cc2ae9edbc36Revision changes
    • warning

      removed the optional property //// from the response with the status

  • bc159968f211Revision changes
    • info

      added the new optional query request parameter tags

    • info

      added the optional property // to the response with the status