Skip to content
cresvaDevelopers

Documentation for this storefront, HTML or JSON by Accept

GET/api/storefront/{brandId}/docs
No keyCallable anonymously. Rate limited by IP.10 requests a minute

Parameters

brandIdstring · pathrequiredThe storefront's brand id. There is no public endpoint that maps a domain to a brand id; ask the merchant for their storefront URL, the id is in it.

Request

bash
BRAND_ID=cmqmr1f6j0003la04nu93f4k4
curl "https://cresva.ai/api/storefront/$BRAND_ID/docs"

Response

Captured from production on 2026-09-16: 200 in 612ms. This is what the endpoint returned, not an example of what it might.

JSON
{
  "protocol": "Agent Query Protocol",
  "version": "1.0",
  "supported_versions": [
    "1.0"
  ],
  "description": "Structured product discovery API optimized for AI agents. Supports search, comparison, recommendations, and detailed product lookups via a single unified query endpoint.",
  "base_url": "https://cresva.ai/api/storefront/cmqmr1f6j0003la04nu93f4k4",
  "endpoints": {
    "query": {
      "method": "POST",
      "path": "https://cresva.ai/api/storefront/cmqmr1f6j0003la04nu93f4k4/query",
      "description": "Unified query endpoint — the primary way to interact with this storefront. Supports all intent types via a single request shape.",
      "content_type": "application/json",
      "authentication": "Bearer token via Authorization header, or query param ?api_key=...",
      "version_negotiation": "Set Accept: application/vnd.cresva.v1.0+json to pin a protocol version.",
      "request_schema": {
        "protocol_version": {
          "type": "string",
          "default": "1.0"
        },
        "request_id": {
          "type": "string",
          "description": "Unique request identifier (auto-generated if omitted)"
        },
        "timestamp": {
          "type": "string",
          "format": "ISO 8601"
        },
        "agent": {
          "platform": {
            "type": "string",
            "required": true,
            "description": "Agent platform name (e.g. chatgpt, claude, perplexity)"
          },
          "version": {
            "type": "string",
            "optional": true
          },
          "session_id": {
            "type": "string",
            "optional": true
          }
        },
        "query": {
          "text": {
            "type": "string",
            "description": "Natural language query (max 500 chars)"
          },
          "intent": {
            "type": "string",
            "enum": [
              "search",
              "compare",
              "recommend",
              "detail",
              "review",
              "availability"
            ],
            "description": "Declared intent (auto-detected from text if omitted)"
          },
          "filters": {
            "category": {
              "type": "string"
            },
            "price_min": {
              "type": "number"
            },
            "price_max": {
              "type": "number"
            },
            "currency": {
              "type": "string",
              "default": "USD"
            },
            "in_stock": {
              "type": "boolean"
            },
            "rating_min": {
              "type": "number",
              "min": 0,
              "max": 5
            },
            "attributes": {
              "type": "object",
              "description": "Key-value attribute filters"
            }
          },
          "context": {
            "user_budget": {
              "type": "number"
            },
            "user_preferences": {
              "type": "string[]"
            },
            "previous_products_viewed": {
              "type": "string[]"
            },
            "comparison_against": {
              "type": "string[]",
              "description": "Product IDs for comparison intent"
            }
          }
        },
        "pagination": {
          "page": {
            "type": "number",
            "default": 1
          },
          "limit": {
            "type": "number",
            "default": 20,
            "max": 50
          }
        },
        "response": {
          "format": {
            "type": "string",
            "enum": [
              "full",
              "summary",
              "minimal"
            ],
            "default": "full"
          },
          "language": {
            "type": "string",
            "default": "en"
          }
        }
      },
      "response_shape": {
        "protocol_version": "string",
        "request_id": "string",
        "meta": {
          "brand": "string",
         
… truncated at 4000 characters

Response codes

200HTML or JSON depending on Accept.

No body.

401The key does not match any active key.
erroranyTwo shapes exist across this API and that is deliberate rather than untidy. Each route kept the error shape it already used, so an existing client's error handling keeps working. See x-cresva-error-shapes.
403The key is valid but belongs to a different brand than the one in the path. Keys are scoped to one brand and do not travel.
erroranyTwo shapes exist across this API and that is deliberate rather than untidy. Each route kept the error shape it already used, so an existing client's error handling keeps working. See x-cresva-error-shapes.
404No such brand.
erroranyTwo shapes exist across this API and that is deliberate rather than untidy. Each route kept the error shape it already used, so an existing client's error handling keeps working. See x-cresva-error-shapes.
429Over the rate limit.
erroranyTwo shapes exist across this API and that is deliberate rather than untidy. Each route kept the error shape it already used, so an existing client's error handling keeps working. See x-cresva-error-shapes.
503The rate limiter could not be reached, so the request was refused rather than served unmetered. Deliberately not a 429: the caller has done nothing wrong and the fault is ours.
erroranyTwo shapes exist across this API and that is deliberate rather than untidy. Each route kept the error shape it already used, so an existing client's error handling keeps working. See x-cresva-error-shapes.

Generated from the storefront OpenAPI document at growthagents 269d7898b, sha256 047fe4d301258100. Nothing on this page was typed by hand.