# Generate a brand review

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.

Endpoint: POST /api/skills/v1/brandreview/generate
Version: v1
Security: HTTPBearer

## Security:

  - `HTTPBearer` (unknown)
    http bearer

## Header parameters:

  - `x-sc-feature` (string)
    The feature within a Sitecore product that initiates the request.

  - `x-sc-interaction-type` (string)
    The type of AI interaction triggered by the feature. This value categorizes AI operations for usage reporting and entitlement tracking.

  - `x-sc-sellable-product` (string)
    The Sitecore product that provides the feature used in the request. This value is used to track entitlement consumption for the related AI interaction.

  - `x-sc-params` (any)
    A comma‑separated list of key-value pairs that reports usage to the consumption and usage services.

## Request fields (application/json):

  - `brandkitId` (string, required)
    The unique identifier of the brand kit that defines the guidelines to evaluate against.
To get this value, use the [List brand kits](https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kits_api_brands_v1_organizations__organizationid__brandkits_get) endpoint to return the `id` of each brand kit in your organization.
    Example: d2c2df7a-1137-43dd-bba3-73ec313526b1

  - `input` (object, 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"}}

  - `sections` (any)
    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](https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kit_sections_api_brands_v1_organizations__organizationid__brandkits__brandkitid__sections_get) endpoint.
To get the field IDs, use the [List brand kit subsections](https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kit_section_fields_api_brands_v2_organizations__organizationid__brandkits__brandkitid__sections__sectionid__fields_get) endpoint.
    Example: [{"fields":["8cf1b172-0277-4aa3-9bb4-252f09f148fd"],"sectionId":"0b3197be-f0b7-462a-a2e5-3388a132ee3f"}]

  - `sections.sectionId` (string, required)
    The unique identifier of a brand kit section whose rules are used to evaluate the input content.
To get the section IDs, use the [List brand kit sections](https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kit_sections_api_brands_v1_organizations__organizationid__brandkits__brandkitid__sections_get) endpoint.
    Example: 0b3197be-f0b7-462a-a2e5-3388a132ee3f

  - `sections.fieldIds` (any)
    The unique identifiers of brand kit fields (subsections) whose rules are used to evaluate the input content.
To get the field IDs, use the [List brand kit subsections](https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kit_section_fields_api_brands_v2_organizations__organizationid__brandkits__brandkitid__sections__sectionid__fields_get) endpoint.
    Example: 8cf1b172-0277-4aa3-9bb4-252f09f148fd

## Response 200:

  - `200` (unknown)
    Successful response

## Response 200 fields (application/json):

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

  - `reviews.sectionId` (string)
    The unique identifier of the brand kit section whose rules were applied when evaluating the input content.
    Example: 0b3197be-f0b7-462a-a2e5-3388a132ee3f

  - `reviews.score` (integer)
    The overall compliance score that reflects how well the input content aligns with the rules defined in this brand kit section, where 5 indicates the highest level of alignment.
    Example: 4

  - `reviews.reason` (string)
    A detailed explanation of the compliance score, describing how the input content aligns with or deviates from the rules defined in this section, including strengths and areas for improvement.
    Example: The content demonstrates a strong adherence to brand guidelines, effectively capturing the brand's tone of voice and messaging. However, there are minor inconsistencies in terminology that could be im…

  - `reviews.suggestion` (string)
    A set of practical recommendations for improving how the input content aligns with the brand guidelines defined in this section.
    Example: Consider using more consistent terminology that aligns with the brand guidelines, and ensure that the tone remains professional throughout.

  - `reviews.fields` (array)
    A list of subsection (field)-level evaluation results within the section. Each entry describes how the input content aligns with the rules defined in a specific field, including a score, explanation, and suggestions.
    Example: [{"fieldId":"8cf1b172-0277-4aa3-9bb4-252f09f148fd","score":4,"reason":"The content effectively captures the brand's tone of voice and messaging, but there are minor inconsistencies in terminology that…

  - `reviews.fields.fieldId` (string)
    The unique identifier of the brand kit field (subsection) whose guidelines were used as the basis for evaluating the input content.
    Example: 8cf1b172-0277-4aa3-9bb4-252f09f148fd

  - `reviews.fields.score` (integer)
    A compliance score indicating how well the input content aligns with the guidelines defined in this brand kit field, where 5 indicates the highest level of alignment.
    Example: 4

  - `reviews.fields.reason` (string)
    A detailed explanation of the score, describing how the input content aligns with or deviates from the guidelines defined in this brand kit field.
    Example: The content effectively captures the brand's tone of voice and messaging, but there are minor inconsistencies in terminology that could be improved.

  - `reviews.fields.suggestion` (string)
    Practical recommendations for improving the input content to better align with the guidelines defined in this brand kit field.
    Example: Consider using more consistent terminology that aligns with the brand guidelines, and ensure that the tone remains professional throughout.

## Response 422:

  - `422` (unknown)
    Unprocessable entity

## Response 422 fields (application/json):

  - `detail` (array)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)