Sign in
stores

List stores

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

Query parameters

limitinteger

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

Example:10

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

afterstring nullable

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

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

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

beforestring nullable

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

Example:eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==

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

include_totalboolean

Whether to include total count in response (expensive operation)

Whether to include total count in response (expensive operation)

qstring nullable

Search query for fuzzy matching over name and description fields

Search query for fuzzy matching over name and description fields

tagsstring[] nullable

Only return stores that carry every one of these tags

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