Sitecore API catalog/Brand Review API/Brand review

Brand review

The Brand Review API lets you evaluate input content and assets against the guidelines defined in a brand kit using AI-powered analysis. The API analyzes the provided content against the rules in selected brand kit sections and subsections (fields) and returns compliance results with 1 to 5 scores, explanations, and improvement suggestions at the section and field level.

Operations

Generate a brand review

Request

Generates a brand review using AI by evaluating the provided input against the specified brand kit, including its sections and subsections(fields). The review returns compliance scores, explanations, and improvement suggestions.

Security
HTTPBearer
Headers
x-sc-featurestring(X-Sc-Feature)

The feature within a Sitecore product that initiates the request.

Example:brand-review
x-sc-interaction-typestring(X-Sc-Interaction-Type)

The type of AI interaction triggered by the feature. This value categorizes AI operations for usage reporting and entitlement tracking.

Example:generate
x-sc-sellable-productstring(X-Sc-Sellable-Product)

The Sitecore product that provides the feature used in the request. This value is used to track entitlement consumption for the related AI interaction.

Example:stream
x-sc-paramsstring or null(X-Sc-Params)
Example:feature=extraction-skills, interaction-type=extraction, sellable-product-code=ai
Any of:

A comma‑separated list of key-value pairs that reports usage to the consumption and usage services.

string
Bodyapplication/jsonrequired
brandkitIdstring, (uuid)(Brandkitid)required

The unique identifier of the brand kit that defines the guidelines to evaluate against. To get this value, use the List brand kits endpoint to return the id of each brand kit in your organization.

Example:"d2c2df7a-1137-43dd-bba3-73ec313526b1"
inputobject(Input)required

The content, asset, or file to evaluate in the brand review. This object is a flexible map of input types, such as text, documents, images, or other extractable files. Values can be provided as raw content or as files from which content can be extracted.

Example:
{
  "document": {
    "name": "sample.pdf",
    "type": "document",
    "url": "https://www.eolss.net/sample-chapters/C01/E6-15-01-03.pdf",
    "mimeType": "application/pdf"
  }
}
sectionsArray of objects or null(Sections)
Example:
[
  {
    "fields": [ … ],
    "sectionId": "0b3197be-f0b7-462a-a2e5-3388a132ee3f"
  }
]
Any of:

A list of brand kit section and subsection(field) IDs that define which brand rules are applied when evaluating the input content.

  • If not provided, the input content is evaluated against all sections and subsections in the brand kit.
  • If only a sectionId is provided, the input content is evaluated against all subsections (fields) within that section.

To get the section IDs, use the List brand kit sections endpoint.

To get the field IDs, use the List brand kit subsections endpoint.

curl -i -X POST \
  https://edge-platform.sitecorecloud.io/stream/ai-skills-api/api/skills/v1/brandreview/generate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-sc-feature: brand-review' \
  -H 'x-sc-interaction-type: generate' \
  -H 'x-sc-params: feature=extraction-skills, interaction-type=extraction, sellable-product-code=ai' \
  -H 'x-sc-sellable-product: stream' \
  -d '{
    "brandkitId": "f6c0ae91-674a-479f-9c4f-05bdb401bb4b",
    "input": {
      "document": {
        "auth": {
          "authType": "bearer",
          "value": "token123"
        },
        "detail": "high",
        "mimeType": "application/pdf",
        "name": "example.pdf",
        "type": "document",
        "url": "https://example.com/document.pdf"
      }
    },
    "sections": [
      {
        "fields": [
          "8cf1b172-0277-4aa3-9bb4-252f09f148fd"
        ],
        "sectionId": "0b3197be-f0b7-462a-a2e5-3388a132ee3f"
      }
    ]
  }'

Responses

Successful response

Bodyapplication/json
reviewsArray of objects(Reviews)

A list of section-level evaluation results generated from the brand review, including subsection (field)-level compliance details.

Response
{
  "reviews": [
    { … }
  ]
}