> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative.
> - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key.
> - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste.
> - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`.
> - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt

# Amazon: Get listing reviews

> Retrieve customer reviews for an Amazon listing.

### Limitations
Reviews are collected on demand and commonly take 30-120 seconds. Allow a client timeout greater than 150 seconds. A longer client timeout does not extend server or source time limits; slow source requests may still return source_unavailable. The source collects and bills whole pages of 10 reviews per star rating. A star quota below 10 reduces returned rows, but does not reduce source work or source cost.

### Data and provenance
By default, each value includes value and source. Shared collection time, license, origin, and value_type are grouped in meta.sources. Use provenance=full for complete per-value provenance. Requested fields not delivered by a source are listed in missing with a reason.

<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->

## Request contract

* **Method and path:** GET /apis/v1/commerce/amazon/listings/\{country}/\{listing\_id}/reviews
* **Availability:** enabled
* **Request URL template:** `https://api.aisa.one/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews`
* **country:** path; required
* **listing\_id:** path; required
* **star\_1\_limit:** query; optional
* **star\_2\_limit:** query; optional
* **star\_3\_limit:** query; optional
* **star\_4\_limit:** query; optional
* **star\_5\_limit:** query; optional
* **sort\_by:** query; optional
* **format\_type:** query; optional
* **reviewer\_type:** query; optional
* **media\_type:** query; optional
* **q:** query; optional
* **fields:** query; optional
* **provenance:** query; optional
* **Runtime facts:** e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8

[Complete OpenAPI definition](https://aisa.one/docs/reference-contracts/aisa-commerce.json)

Effective request and pricing declaration (including authentication and referenced schemas):

```json theme={null}
{
  "operationId": "get_aisa_commerce_apis_v1_commerce_amazon_listing_4ba29d",
  "method": "GET",
  "path": "/apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
      "in": "path",
      "name": "country",
      "required": true,
      "schema": {
        "description": "Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not UK). See the enum for supported countries.",
        "enum": [
          "DE",
          "GB",
          "US"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Native product ID on the platform.",
      "in": "path",
      "name": "listing_id",
      "required": true,
      "schema": {
        "description": "Native product ID on the platform.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Maximum number of 1-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
      "in": "query",
      "name": "star_1_limit",
      "required": false,
      "schema": {
        "description": "Maximum number of 1-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Maximum number of 2-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
      "in": "query",
      "name": "star_2_limit",
      "required": false,
      "schema": {
        "description": "Maximum number of 2-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Maximum number of 3-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
      "in": "query",
      "name": "star_3_limit",
      "required": false,
      "schema": {
        "description": "Maximum number of 3-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Maximum number of 4-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
      "in": "query",
      "name": "star_4_limit",
      "required": false,
      "schema": {
        "description": "Maximum number of 4-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Maximum number of 5-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
      "in": "query",
      "name": "star_5_limit",
      "required": false,
      "schema": {
        "description": "Maximum number of 5-star reviews. If any star quota is supplied, omitted star quotas default to 0.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. published_at sorts newest reviews first; the response exposes date_text rather than a same-named field. helpful_count sorts by helpful votes in descending order.",
      "in": "query",
      "name": "sort_by",
      "required": false,
      "schema": {
        "description": "Sort key. Usually an output field name; operation-specific notes explain keys that do not correspond to an output field. published_at sorts newest reviews first; the response exposes date_text rather than a same-named field. helpful_count sorts by helpful votes in descending order.",
        "enum": [
          "helpful_count",
          "published_at"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Review scope: all variants or current_variant only.",
      "in": "query",
      "name": "format_type",
      "required": false,
      "schema": {
        "description": "Review scope: all variants or current_variant only.",
        "enum": [
          "all",
          "current_variant"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Reviewer filter: all reviewers or verified_purchase only.",
      "in": "query",
      "name": "reviewer_type",
      "required": false,
      "schema": {
        "description": "Reviewer filter: all reviewers or verified_purchase only.",
        "enum": [
          "all",
          "verified_purchase"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Review content filter: all or with_media (images or videos).",
      "in": "query",
      "name": "media_type",
      "required": false,
      "schema": {
        "description": "Review content filter: all or with_media (images or videos).",
        "enum": [
          "all",
          "with_media"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Search keywords.",
      "in": "query",
      "name": "q",
      "required": false,
      "schema": {
        "description": "Search keywords.",
        "type": [
          "string",
          "null"
        ]
      }
    },
    {
      "description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
      "explode": false,
      "in": "query",
      "name": "fields",
      "required": false,
      "schema": {
        "description": "Comma-separated business field paths to return. Omit to use this operation's default field selection. The enum includes all fields of the shared item type. Some are populated only by other operations on the same platform; selecting them here does not supply missing data. Field selection trims output only and does not reduce source calls or charges.",
        "items": {
          "enum": [
            "date_text",
            "helpful_count",
            "rating_score",
            "relation.listing_id",
            "review_country",
            "reviewer_name",
            "text",
            "title",
            "variation_attributes",
            "verified_purchase",
            "vine"
          ],
          "type": "string"
        },
        "type": [
          "array",
          "null"
        ]
      },
      "style": "form"
    },
    {
      "description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
      "in": "query",
      "name": "provenance",
      "required": false,
      "schema": {
        "default": "compact",
        "description": "compact (default) returns value and source per field. Shared collection time, license, origin, and value_type are grouped in meta.sources; differing values retain their own metadata. full returns complete per-value provenance, including precision and confidence.",
        "enum": [
          "compact",
          "full"
        ],
        "type": [
          "string",
          "null"
        ]
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cache_hit_share_bps": 10000,
    "customer_micros_usd": 250000,
    "customer_pricing_ref": "commerce.amazon.listing_reviews.query.v1.pricing@1",
    "description": "Charged once per delivered read: an entity with at least one requested field, or one page of a result set. A read that delivers nothing is not charged. A read answered from stored values is charged the cache-hit share of the price. Variants are priced by the route parameters they fix.",
    "kind": "fixed_request"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}
```

## Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.


## OpenAPI

````yaml reference-contracts/aisa-commerce.json GET /apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews
openapi: 3.1.0
info:
  description: ''
  title: AIsa commerce
  version: '1'
  x-aisa-capabilities:
    idempotency: Idempotency-Key
    max_price: X-AISA-Max-Price-USD
    quote:
      header: X-AISA-Cost-Mode
      value: quote
  x-aisa-configured-paths: []
  x-aisa-document:
    facts_hash: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
    generator_version: '3'
    protocol_version: '1'
    schema_version: '1'
    composer_version: '27'
    response_pending: []
    document_hash: sha256:d613c2f34a6d7f2b6fe218d384f60674caa24284ef502a3778d3fb4c04d755a3
  x-aisa-plans:
    builder: 1
    display_plan: payg
    payg: 1
    similarweb_payg: 1
    team: 1
    version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
  x-aisa-provider: aisa-commerce
  x-aisa-catalogs:
    aisa-commerce:
      title: AIsa commerce
      description: ''
      x-aisa-document:
        facts_hash: e4ea23246d148272326d4d18f79f43b8fa99cd58edd96f4f3759a860c1c99cf8
        generator_version: '3'
        protocol_version: '1'
        schema_version: '1'
      x-aisa-plans:
        builder: 1
        display_plan: payg
        payg: 1
        similarweb_payg: 1
        team: 1
        version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
      x-aisa-capabilities:
        idempotency: Idempotency-Key
        max_price: X-AISA-Max-Price-USD
        quote:
          header: X-AISA-Cost-Mode
          value: quote
servers:
  - url: https://api.aisa.one
security:
  - bearerAuth: []
paths:
  /apis/v1/commerce/amazon/listings/{country}/{listing_id}/reviews:
    get:
      summary: 'Amazon: Get listing reviews'
      description: >-
        Retrieve customer reviews for an Amazon listing.


        ### Limitations

        Reviews are collected on demand and commonly take 30-120 seconds. Allow
        a client timeout greater than 150 seconds. A longer client timeout does
        not extend server or source time limits; slow source requests may still
        return source_unavailable. The source collects and bills whole pages of
        10 reviews per star rating. A star quota below 10 reduces returned rows,
        but does not reduce source work or source cost.


        ### Data and provenance

        By default, each value includes value and source. Shared collection
        time, license, origin, and value_type are grouped in meta.sources. Use
        provenance=full for complete per-value provenance. Requested fields not
        delivered by a source are listed in missing with a reason.


        <!-- aisa-pricing:start -->

        A request reference price is not currently available; use a request
        quote where supported. Account-specific pricing and final settlement may
        differ.

        <!-- aisa-pricing:end -->
      operationId: get_aisa_commerce_apis_v1_commerce_amazon_listing_4ba29d
      parameters:
        - description: >-
            Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB, not
            UK). See the enum for supported countries.
          in: path
          name: country
          required: true
          schema:
            description: >-
              Marketplace country as an uppercase ISO 3166-1 alpha-2 code (GB,
              not UK). See the enum for supported countries.
            enum:
              - DE
              - GB
              - US
            type:
              - string
              - 'null'
        - description: Native product ID on the platform.
          in: path
          name: listing_id
          required: true
          schema:
            description: Native product ID on the platform.
            type:
              - string
              - 'null'
        - description: >-
            Maximum number of 1-star reviews. If any star quota is supplied,
            omitted star quotas default to 0.
          in: query
          name: star_1_limit
          required: false
          schema:
            description: >-
              Maximum number of 1-star reviews. If any star quota is supplied,
              omitted star quotas default to 0.
            type:
              - string
              - 'null'
        - description: >-
            Maximum number of 2-star reviews. If any star quota is supplied,
            omitted star quotas default to 0.
          in: query
          name: star_2_limit
          required: false
          schema:
            description: >-
              Maximum number of 2-star reviews. If any star quota is supplied,
              omitted star quotas default to 0.
            type:
              - string
              - 'null'
        - description: >-
            Maximum number of 3-star reviews. If any star quota is supplied,
            omitted star quotas default to 0.
          in: query
          name: star_3_limit
          required: false
          schema:
            description: >-
              Maximum number of 3-star reviews. If any star quota is supplied,
              omitted star quotas default to 0.
            type:
              - string
              - 'null'
        - description: >-
            Maximum number of 4-star reviews. If any star quota is supplied,
            omitted star quotas default to 0.
          in: query
          name: star_4_limit
          required: false
          schema:
            description: >-
              Maximum number of 4-star reviews. If any star quota is supplied,
              omitted star quotas default to 0.
            type:
              - string
              - 'null'
        - description: >-
            Maximum number of 5-star reviews. If any star quota is supplied,
            omitted star quotas default to 0.
          in: query
          name: star_5_limit
          required: false
          schema:
            description: >-
              Maximum number of 5-star reviews. If any star quota is supplied,
              omitted star quotas default to 0.
            type:
              - string
              - 'null'
        - description: >-
            Sort key. Usually an output field name; operation-specific notes
            explain keys that do not correspond to an output field. published_at
            sorts newest reviews first; the response exposes date_text rather
            than a same-named field. helpful_count sorts by helpful votes in
            descending order.
          in: query
          name: sort_by
          required: false
          schema:
            description: >-
              Sort key. Usually an output field name; operation-specific notes
              explain keys that do not correspond to an output field.
              published_at sorts newest reviews first; the response exposes
              date_text rather than a same-named field. helpful_count sorts by
              helpful votes in descending order.
            enum:
              - helpful_count
              - published_at
            type:
              - string
              - 'null'
        - description: 'Review scope: all variants or current_variant only.'
          in: query
          name: format_type
          required: false
          schema:
            description: 'Review scope: all variants or current_variant only.'
            enum:
              - all
              - current_variant
            type:
              - string
              - 'null'
        - description: 'Reviewer filter: all reviewers or verified_purchase only.'
          in: query
          name: reviewer_type
          required: false
          schema:
            description: 'Reviewer filter: all reviewers or verified_purchase only.'
            enum:
              - all
              - verified_purchase
            type:
              - string
              - 'null'
        - description: 'Review content filter: all or with_media (images or videos).'
          in: query
          name: media_type
          required: false
          schema:
            description: 'Review content filter: all or with_media (images or videos).'
            enum:
              - all
              - with_media
            type:
              - string
              - 'null'
        - description: Search keywords.
          in: query
          name: q
          required: false
          schema:
            description: Search keywords.
            type:
              - string
              - 'null'
        - description: >-
            Comma-separated business field paths to return. Omit to use this
            operation's default field selection. The enum includes all fields of
            the shared item type. Some are populated only by other operations on
            the same platform; selecting them here does not supply missing data.
            Field selection trims output only and does not reduce source calls
            or charges.
          explode: false
          in: query
          name: fields
          required: false
          schema:
            description: >-
              Comma-separated business field paths to return. Omit to use this
              operation's default field selection. The enum includes all fields
              of the shared item type. Some are populated only by other
              operations on the same platform; selecting them here does not
              supply missing data. Field selection trims output only and does
              not reduce source calls or charges.
            items:
              enum:
                - date_text
                - helpful_count
                - rating_score
                - relation.listing_id
                - review_country
                - reviewer_name
                - text
                - title
                - variation_attributes
                - verified_purchase
                - vine
              type: string
            type:
              - array
              - 'null'
          style: form
        - description: >-
            compact (default) returns value and source per field. Shared
            collection time, license, origin, and value_type are grouped in
            meta.sources; differing values retain their own metadata. full
            returns complete per-value provenance, including precision and
            confidence.
          in: query
          name: provenance
          required: false
          schema:
            default: compact
            description: >-
              compact (default) returns value and source per field. Shared
              collection time, license, origin, and value_type are grouped in
              meta.sources; differing values retain their own metadata. full
              returns complete per-value provenance, including precision and
              confidence.
            enum:
              - compact
              - full
            type:
              - string
              - 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    items:
                      properties:
                        fields:
                          properties:
                            date_text:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            helpful_count:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            rating_score:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            relation:
                              properties:
                                listing_id:
                                  properties:
                                    confidence:
                                      type:
                                        - number
                                        - 'null'
                                    dims:
                                      additionalProperties:
                                        type:
                                          - string
                                          - 'null'
                                      type:
                                        - object
                                        - 'null'
                                    fetched_at:
                                      format: date-time
                                      type:
                                        - string
                                        - 'null'
                                    license:
                                      type:
                                        - string
                                        - 'null'
                                    metric:
                                      type:
                                        - string
                                        - 'null'
                                    origin:
                                      type:
                                        - string
                                        - 'null'
                                    period_end:
                                      format: date-time
                                      type:
                                        - string
                                        - 'null'
                                    period_start:
                                      format: date-time
                                      type:
                                        - string
                                        - 'null'
                                    precision:
                                      type:
                                        - string
                                        - 'null'
                                    source:
                                      type:
                                        - string
                                        - 'null'
                                    sources:
                                      items:
                                        type:
                                          - string
                                          - 'null'
                                      type:
                                        - array
                                        - 'null'
                                    value: {}
                                    value_type:
                                      type:
                                        - string
                                        - 'null'
                                    verified:
                                      type:
                                        - boolean
                                        - 'null'
                                  type:
                                    - object
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            review_country:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            reviewer_name:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            text:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            title:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            variation_attributes:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            verified_purchase:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                            vine:
                              properties:
                                confidence:
                                  type:
                                    - number
                                    - 'null'
                                dims:
                                  additionalProperties:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - object
                                    - 'null'
                                fetched_at:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                license:
                                  type:
                                    - string
                                    - 'null'
                                metric:
                                  type:
                                    - string
                                    - 'null'
                                origin:
                                  type:
                                    - string
                                    - 'null'
                                period_end:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                period_start:
                                  format: date-time
                                  type:
                                    - string
                                    - 'null'
                                precision:
                                  type:
                                    - string
                                    - 'null'
                                source:
                                  type:
                                    - string
                                    - 'null'
                                sources:
                                  items:
                                    type:
                                      - string
                                      - 'null'
                                  type:
                                    - array
                                    - 'null'
                                value: {}
                                value_type:
                                  type:
                                    - string
                                    - 'null'
                                verified:
                                  type:
                                    - boolean
                                    - 'null'
                              type:
                                - object
                                - 'null'
                          type:
                            - object
                            - 'null'
                        flags:
                          items:
                            type:
                              - string
                              - 'null'
                          type:
                            - array
                            - 'null'
                        key:
                          type:
                            - string
                            - 'null'
                        kind:
                          type:
                            - string
                            - 'null'
                        rank:
                          type:
                            - integer
                            - 'null'
                      type:
                        - object
                        - 'null'
                    type:
                      - array
                      - 'null'
                  meta:
                    properties:
                      sources:
                        additionalProperties:
                          properties:
                            fetched_at:
                              format: date-time
                              type:
                                - string
                                - 'null'
                            license:
                              type:
                                - string
                                - 'null'
                            origin:
                              type:
                                - string
                                - 'null'
                            value_type:
                              type:
                                - string
                                - 'null'
                          type:
                            - object
                            - 'null'
                        type:
                          - object
                          - 'null'
                    type:
                      - object
                      - 'null'
                  missing:
                    items:
                      properties:
                        reason:
                          type:
                            - string
                            - 'null'
                        source:
                          type:
                            - string
                            - 'null'
                      type:
                        - object
                        - 'null'
                    type:
                      - array
                      - 'null'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                type: object
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcePublicError'
          description: >-
            Authentication failed. Execution-mode gateway errors use a string
            error with top-level code and request_id; cost-quote authentication
            errors use a nested error object whose request_id may be omitted.
            Resource errors use the full nested envelope.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourcePublicError'
          description: >-
            Resource errors use the full nested envelope. Gateway authentication
            errors use the flat execution-mode shape or the nested cost-quote
            shape (request_id is omitted by some quote failures). Use
            X-Request-ID for support correlation.
components:
  schemas:
    ResourcePublicError:
      oneOf:
        - $ref: '#/components/schemas/ResourceError'
        - $ref: '#/components/schemas/GatewayAuthError'
        - $ref: '#/components/schemas/GatewayQuoteError'
    ResourceError:
      properties:
        error:
          properties:
            code:
              type: string
            details:
              items:
                properties:
                  code:
                    type:
                      - string
                      - 'null'
                  field:
                    type:
                      - string
                      - 'null'
                  message:
                    type:
                      - string
                      - 'null'
                type:
                  - object
                  - 'null'
              type:
                - array
                - 'null'
            message:
              type: string
            request_id:
              type: string
            retry_hint:
              type: string
            retryable:
              type: boolean
            type:
              type: string
          required:
            - code
            - type
            - message
            - request_id
            - retryable
            - retry_hint
          type: object
      required:
        - error
      type: object
    GatewayAuthError:
      properties:
        code:
          type: string
        error:
          type: string
        request_id:
          type: string
      required:
        - code
        - error
        - request_id
      type: object
    GatewayQuoteError:
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            details:
              type: object
            message:
              type: string
            request_id:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.