Skip to content
cresvaDevelopers

A ChatGPT tailored OpenAPI document for this brand

GET/api/storefront/{brandId}/platforms/openai/openapi
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/platforms/openai/openapi"

Response

Captured from production on 2026-09-16: 200 in 2891ms, X-OSP-Version: 2026-03-01. This is what the endpoint returned, not an example of what it might.

JSON
{
  "openapi": "3.1.0",
  "info": {
    "title": "Cresva — ACP Storefront",
    "version": "1.0.0",
    "description": "AI-native product API for Cresva. Search products, compare options, negotiate prices, check trust scores, and complete transactions via the Agent Commerce Protocol."
  },
  "servers": [
    {
      "url": "https://cresva.ai/api/storefront/cmqmr1f6j0003la04nu93f4k4"
    }
  ],
  "paths": {
    "/query": {
      "post": {
        "operationId": "queryProducts",
        "summary": "Search products with natural language",
        "description": "Submit a natural language query to search the product catalog. Supports filters, intent classification, and personalized recommendations.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "query"
                ],
                "properties": {
                  "query": {
                    "type": "object",
                    "properties": {
                      "text": {
                        "type": "string",
                        "description": "Natural language search query"
                      },
                      "filters": {
                        "type": "object",
                        "properties": {
                          "category": {
                            "type": "string"
                          },
                          "price_min": {
                            "type": "number"
                          },
                          "price_max": {
                            "type": "number"
                          },
                          "in_stock": {
                            "type": "boolean"
                          }
                        }
                      },
                      "intent": {
                        "type": "string",
                        "enum": [
                          "search",
                          "compare",
                          "recommend",
                          "detail"
                        ]
                      }
                    }
                  },
                  "pagination": {
                    "type": "object",
                    "properties": {
                      "page": {
                        "type": "integer",
                        "default": 1
                      },
                      "limit": {
                        "type": "integer",
                        "default": 10
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Product results with relevance scores, pricing, and agent context"
          }
        }
      }
    },
    "/search": {
      "get": {
        "operationId": "searchProducts",
        "summary": "Keyword search for products",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Search query"
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 10
            }
          },
          {
            "name": "category",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results"
          }
        }
      }
    },
    "/products": {
      "get": {
        "operationId": "listProducts",
        "summary": "List available products",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer"
… truncated at 4000 characters

Response codes

200An OpenAPI 3.1 document covering 8 paths.
object
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.