{"items":[{"type":"link","label":"Brand Review API","link":"/ai-skills/ai-brand-review-admin-rest-api","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api","content":{"contentType":"overview","meta":{"name":"Brand Review API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ai-skills/ai-brand-review-admin-rest-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ai-skills/ai-brand-review-admin-rest-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"attribute","title":"License","titleTranslationKey":"info.license","label":"Closed source","value":"Closed source"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://edge-platform.sitecorecloud.io/stream/ai-skills-api","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Brand Review API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Brand Review REST API to evaluate input content and assets against brand guidelines using AI-powered analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API analyzes content provided in the request, such as text, images, and files, by comparing it against brand kit sections for a specific tenant and organization. The analysis can evaluate content against all brand kit sections or selected sections, such as "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand Context"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global Goals"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tone of Voice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". SitecoreAI generates compliance scores, explanations, and improvement suggestions based on this analysis."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this REST API to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide content in the request body for brand evaluation against brand kit guidelines."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assess how the input content aligns with specific brand kit sections and subsections (fields), including "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Brand Context"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do’s and Don’ts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tone of Voice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grammar Checklists"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visual Guidelines"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receive a brand compliance score for the input content on a scale from 1 to 5, where 5 indicates the highest level of alignment with the brand guidelines."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Evaluate multiple input formats, including text, images, PDFs, metadata, Markdown, and JSON."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a review is generated, teams can use the results to enforce brand consistency at scale, validate content in real time using AI-suggested improvements, and reduce compliance risk by identifying brand, legal, and accessibility issues. Compliance scores and explanations help pinpoint problem areas at the section or field level and reveal recurring trends across content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests typically complete within 5 seconds. Batching is not supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple input formats are supported, including content from SitecoreAI or XP pages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this REST API, you must authenticate all API requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official Sitecore documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api"}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authorization"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Brand Review REST API uses the OAuth 2.0 standard with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/stream/en/users/sitecore-stream/generate-a-json-web-token--jwt-.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON web tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to authorize REST API requests."},"children":[]}]}]}]}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authorization/create-client-id-and-client-secret"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create Client ID and Client Secret"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Sitecore Cloud Portal, open Stream."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI APIs keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create credential"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"​Create New Client​​"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dialog, enter a name and description for the client. Then click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The ​Client ID and Client Secret​​ display."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the Client ID and Client Secret because you won't be able to view them again in Stream. You'll use them to request an access token."},"children":[]}]}]}]}]}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/create-client-id-and-client-secret"}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/create-client-id-and-client-secret"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authorization/request-an-access-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run the following cURL command to request an access token. Replace the placeholder values with your Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_API_KEY}' \\\n  --data-urlencode 'client_secret={YOUR_API_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_API_KEY}' \\\n  --data-urlencode 'client_secret={YOUR_API_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key contains the access token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_ACCESS_TOKEN}\",\n    \"scope\": \"ai.orgs.br:gen ai.org.brd:w ai.org.brd:r ai.org.docs:w ai.org.docs:r ai.org:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  {\n    \"access_token\": \"{YOUR_ACCESS_TOKEN}\",\n    \"scope\": \"ai.orgs.br:gen ai.org.brd:w ai.org.brd:r ai.org.docs:w ai.org.docs:r ai.org:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens expire in 24 hours. If your requests unexpectedly return a response with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", request a new access token by repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend that you cache the access token for 24 hours to avoid repeating this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request while the access token is still valid."},"children":[]}]}]}]}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/request-an-access-token"}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/request-an-access-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authorization/include-the-access-token-in-the-request-header"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the access token in the request header"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now start making REST API requests. You must include the access token in the request header of every request. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/v2/...' \\\n-H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \\\n-H 'Accept: application/json'\n","language":"curl"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET '{YOUR_BASE_URL}/v2/...' \\\n-H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \\\n-H 'Accept: application/json'\n"},"children":[]}]}]}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/include-the-access-token-in-the-request-header"}],"sectionId":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/include-the-access-token-in-the-request-header"}]}]}},{"type":"group","label":"Authorization","link":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization","items":[{"type":"link","label":"Create Client ID and Client Secret","link":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/create-client-id-and-client-secret","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/create-client-id-and-client-secret","content":null},{"type":"link","label":"Request an access token","link":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/request-an-access-token","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/request-an-access-token","content":null},{"type":"link","label":"Include the access token in the request header","link":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/include-the-access-token-in-the-request-header","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/section/authorization/include-the-access-token-in-the-request-header","content":null}],"content":null},{"type":"group","label":"Brand review","link":"/ai-skills/ai-brand-review-admin-rest-api/brand-review","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/brand-review","items":[{"label":"Generate a brand review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ai-skills/ai-brand-review-admin-rest-api/brand-review/generate_brand_review_api_skills_v1_brandreview_generate_post","routeSlug":"/ai-skills/ai-brand-review-admin-rest-api/brand-review/generate_brand_review_api_skills_v1_brandreview_generate_post","metadata":{"seo":{"title":"Generate a brand review","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate_brand_review_api_skills_v1_brandreview_generate_post","name":"Generate a brand review","isWebhook":false,"pointer":"/paths/~1api~1skills~1v1~1brandreview~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a brand review","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"HTTPBearer","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-sc-feature","in":"header","schemaId":"schema_814","description":"The feature within a Sitecore product that initiates the request."},{"name":"x-sc-interaction-type","in":"header","schemaId":"schema_815","description":"The type of AI interaction triggered by the feature. This value categorizes AI operations for usage reporting and entitlement tracking."},{"name":"x-sc-sellable-product","in":"header","schemaId":"schema_816","description":"The Sitecore product that provides the feature used in the request. This value is used to track entitlement consumption for the related AI interaction."},{"name":"x-sc-params","in":"header","schemaId":"schema_817","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma‑separated list of key-value pairs that reports usage to the consumption and usage services."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1skills~1v1~1brandreview~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateBrandReviewModelRequest"}},"schemaId":"components/schemas/GenerateBrandReviewModelRequest","pointer":"/paths/~1api~1skills~1v1~1brandreview~1generate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/skills/v1/brandreview/generate","servers":[{"url":"https://edge-platform.sitecorecloud.io/stream/ai-skills-api","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"x-sc-feature","in":"header","required":false,"example":"brand-review","schemaId":"schema_814"},{"name":"x-sc-interaction-type","in":"header","required":false,"example":"generate","schemaId":"schema_815"},{"name":"x-sc-sellable-product","in":"header","required":false,"example":"stream","schemaId":"schema_816"},{"name":"x-sc-params","in":"header","required":false,"example":"feature=extraction-skills, interaction-type=extraction, sellable-product-code=ai","schemaId":"schema_817"}],"cookie":[]},"security":[{"schemes":[{"id":"HTTPBearer","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GenerateBrandReviewModelRequest"}},"responseCodes":["200","422"],"pointer":"/api/skills/v1/brandreview/generate","href":"brand-review/generate_brand_review_api_skills_v1_brandreview_generate_post","openApiOperationId":"generate_brand_review_api_skills_v1_brandreview_generate_post","summary":"Generate a brand review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform.sitecorecloud.io/stream/ai-skills-api","description":"Production server"}],"schemaId":"components/schemas/GenerateBrandReviewModelRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenerateBrandReviewModelRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateBrandReviewModelResponse"}},"schemaId":"components/schemas/GenerateBrandReviewModelResponse"},{"code":"422","description":"Unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}},"schemaId":"components/schemas/HTTPValidationError"}],"pointer":"/paths/~1api~1skills~1v1~1brandreview~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GenerateBrandReviewModelResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenerateBrandReviewModelResponse"}}},{"code":"422","schemaId":"components/schemas/HTTPValidationError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPValidationError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/brand-review/generate_brand_review_api_skills_v1_brandreview_generate_post"}],"panels":[]}]},"httpPath":"/api/skills/v1/brandreview/generate"}],"content":{"contentType":"group","meta":{"name":"Brand review"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Brand review","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/skills/v1/brandreview/generate","summary":"Generate a brand review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/brand-review/generate_brand_review_api_skills_v1_brandreview_generate_post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AddedContextModel":{"id":"components/schemas/AddedContextModel","kind":"json-schema","title":"AddedContextModel","data":{"properties":{"data":{"type":"string","title":"Data"},"mimeType":{"anyOf":[{"$ref":"#/components/schemas/MimeType"},{"type":"null"}]}},"type":"object","required":["data"],"title":"AddedContextModel"}},"components/schemas/AuthenticationType":{"id":"components/schemas/AuthenticationType","kind":"json-schema","title":"AuthenticationType","data":{"properties":{"authType":{"type":"string","enum":["bearer","basic","custom"],"title":"Authtype","description":"Authentication information required to access a protected file URL.","example":"bearer"},"value":{"type":"string","title":"Value","description":"The authentication value associated with the specified authentication type.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"customHeaderName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customheadername","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the custom HTTP header used for authentication. Required only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"X-Custom-Auth"}},"type":"object","required":["authType","value"],"title":"AuthenticationType"}},"components/schemas/ContentType":{"id":"components/schemas/ContentType","kind":"json-schema","title":"ContentType","data":{"type":"string","enum":["GenericImage","ImageWithTextOverlay","TextEmbeddingForImageSearch","ShortText","LongText","RichDocument"],"title":"ContentType","description":"Content type that determines the method for processing the data and creating embedding(s)"}},"components/schemas/DeepResearchRequest":{"id":"components/schemas/DeepResearchRequest","kind":"json-schema","title":"DeepResearchRequest","data":{"properties":{"prompt":{"type":"string","title":"Prompt","description":"TThe research question or topic to analyze. This drives what content is embedded and explored."},"brandkitId":{"type":"string","title":"Brandkitid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the brand kit that defines the guidelines to evaluate against."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get this value, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kits_api_brands_v1_organizations__organizationid__brandkits_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to return the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of each brand kit in your organization."},"children":[]}]}]}]},"searchType":{"$ref":"#/components/schemas/SearchType","description":"The type of search to perform, influencing how the research prompt is processed and matched against brand content."},"additionalContext":{"items":{"$ref":"#/components/schemas/AddedContextModel"},"type":"array","title":"Additionalcontext","description":"Supplementary context to guide the research, such as background information, constraints, or reference material."}},"type":"object","required":["prompt","brandkitId"],"title":"DeepResearchRequest"}},"components/schemas/DocumentMimeType":{"id":"components/schemas/DocumentMimeType","kind":"json-schema","title":"DocumentMimeType","data":{"type":"string","enum":["application/pdf","text/plain"],"title":"DocumentMimeType","description":"Document MIME types supported for brand review."}},"components/schemas/ExtractableFile":{"id":"components/schemas/ExtractableFile","kind":"json-schema","title":"ExtractableFile","data":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the file to be reviewed.","example":"myarticle.pdf"},"type":{"type":"string","enum":["document","image"],"title":"Type","description":"The type of file to be reviewed.","example":"document"},"url":{"type":"string","title":"Url","description":"The URL from which the file can be downloaded, or a base64-encoded representation of the file content.","example":"https://example.com/myarticle.pdf"},"mimeType":{"anyOf":[{"$ref":"#/components/schemas/DocumentMimeType"},{"$ref":"#/components/schemas/ImageMimeType"}],"title":"Mimetype","description":"The MIME type of the file content.","example":"application/pdf"},"detail":{"anyOf":[{"type":"string","enum":["low","auto","high"]},{"type":"null"}],"title":"Detail","description":"Specifies the level of detail to use when reviewing the content.","default":"auto","example":"high"},"auth":{"anyOf":[{"$ref":"#/components/schemas/AuthenticationType"},{"type":"null"}],"description":"Authentication details for accessing the file URL. Not required when the file content is provided as base64."}},"type":"object","required":["name","type","url","mimeType"],"title":"ExtractableFile","description":"Model representing a file (document or image) that can be downloaded and processed for brand review analysis."}},"components/schemas/FieldReview":{"id":"components/schemas/FieldReview","kind":"json-schema","title":"FieldReview","data":{"properties":{"fieldId":{"type":"string","title":"Fieldid","description":"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"},"score":{"type":"integer","maximum":5,"minimum":1,"title":"Score","description":"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},"reason":{"type":"string","title":"Reason","description":"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."},"suggestion":{"type":"string","title":"Suggestion","description":"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."}},"type":"object","title":"FieldReview"}},"components/schemas/GenerateBrandReviewModelRequest":{"id":"components/schemas/GenerateBrandReviewModelRequest","kind":"json-schema","title":"GenerateBrandReviewModelRequest","data":{"properties":{"brandkitId":{"type":"string","format":"uuid","title":"Brandkitid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the brand kit that defines the guidelines to evaluate against."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get this value, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-docs.sitecore.com/ai-skills/ai-brand-management-rest-api/brand-kit/list_brand_kits_api_brands_v1_organizations__organizationid__brandkits_get"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to return the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of each brand kit in your organization."},"children":[]}]}]}],"example":"d2c2df7a-1137-43dd-bba3-73ec313526b1"},"input":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"$ref":"#/components/schemas/ExtractableFile"},{"items":{"$ref":"#/components/schemas/ExtractableFile"},"type":"array"},{"type":"null"}]},"type":"object","title":"Input","description":"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":{"anyOf":[{"items":{"$ref":"#/components/schemas/Section"},"type":"array"},{"type":"null"}],"title":"Sections","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of brand kit section and subsection(field) IDs that define which brand rules are applied when evaluating the input content."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If not provided, the input content is evaluated against all sections and subsections in the brand kit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sectionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the input content is evaluated against all subsections (fields) within that section."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the section IDs, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kit sections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the field IDs, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kit subsections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"example":[{"fields":["8cf1b172-0277-4aa3-9bb4-252f09f148fd"],"sectionId":"0b3197be-f0b7-462a-a2e5-3388a132ee3f"}]}},"type":"object","required":["brandkitId","input"],"title":"GenerateBrandReviewModelRequest","examples":[{"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"}]},{"brandkitId":"bc25f498-a65e-445e-9f77-c2db9f3465af","input":{"content":"Unleash your potential with Powerful! At Powerful, we believe in fueling your active lifestyle with clean, nutrient-dense energy solutions. Our premium, all-natural power bars and granolas are crafted to nourish your body, support your performance, and inspire healthier living. Whether you're a seasoned athlete or just starting your fitness journey, our products are designed to empower you to push your limits and pursue your passions. With real, natural ingredients and a commitment to transparency, Powerful is your trusted partner in wellness and adventure. Join us in embracing a high-energy, active lifestyle and let Powerful be your source of motivation and strength!"},"sections":[{"fields":["8cf1b172-0277-4aa3-9bb4-252f09f148fd"],"sectionId":"0b3197be-f0b7-462a-a2e5-3388a132ee3f"}]},{"brandkitId":"f6c0ae91-674a-479f-9c4f-05bdb401bb4b","input":{"image":{"detail":"high","mimeType":"image/png","name":"logo.png","type":"image","url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="}}},{"brandkitId":"f6c0ae91-674a-479f-9c4f-05bdb401bb4b","input":{"files":[{"detail":"auto","mimeType":"application/pdf","name":"document.pdf","type":"document","url":"JVBERi0xLjQKJcOkw7zDtsO8w6..."}]}}]}},"components/schemas/GenerateBrandReviewModelResponse":{"id":"components/schemas/GenerateBrandReviewModelResponse","kind":"json-schema","title":"GenerateBrandReviewModelResponse","data":{"properties":{"reviews":{"items":{"$ref":"#/components/schemas/SectionReview"},"type":"array","title":"Reviews","description":"A list of section-level evaluation results generated from the brand review, including subsection (field)-level compliance details."}},"type":"object","title":"GenerateBrandReviewModelResponse"}},"components/schemas/GenerateEmbeddingsModelRequest":{"id":"components/schemas/GenerateEmbeddingsModelRequest","kind":"json-schema","title":"GenerateEmbeddingsModelRequest","data":{"properties":{"input":{"items":{"$ref":"#/components/schemas/InputItem"},"type":"array","maxItems":3,"title":"Input","description":"List of content items for vectorization"},"models":{"anyOf":[{"$ref":"#/components/schemas/LLMModel"},{"type":"null"}],"description":"The global models field overrides the default Large Language Models (LLMs) defined for creating embeddings for specific content types"}},"type":"object","required":["input"],"title":"GenerateEmbeddingsModelRequest"}},"components/schemas/HTTPValidationError":{"id":"components/schemas/HTTPValidationError","kind":"json-schema","title":"HTTPValidationError","data":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"components/schemas/ImageMimeType":{"id":"components/schemas/ImageMimeType","kind":"json-schema","title":"ImageMimeType","data":{"type":"string","enum":["image/jpeg","image/png","image/webp"],"title":"ImageMimeType","description":"Image MIME types supported for brand review.","example":"image/png"}},"components/schemas/InputItem":{"id":"components/schemas/InputItem","kind":"json-schema","title":"InputItem","data":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the content item to create embedding for","example":"Sample Text"},"data":{"type":"string","title":"Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content data - URL | base64 | raw text"},"children":[]}]}]}]},"contentType":{"$ref":"#/components/schemas/ContentType","description":"The type of the content to vectorize, which determines how the data is processed."},"mimeType":{"anyOf":[{"$ref":"#/components/schemas/DocumentMimeType"},{"$ref":"#/components/schemas/ImageMimeType"}],"title":"Mimetype","description":"MIME type of the file","example":"text/plain"},"models":{"anyOf":[{"$ref":"#/components/schemas/LLMModel"},{"type":"null"}],"description":"The models field overrides the default models for the particular content item","example":{"text_embedding":"custom-text-embedding-model-v1","image_embedding":"custom-image-embedding-model-v1","dimensions":512}},"embedImg":{"type":"boolean","title":"Embedimg","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to generate embeddings for all content types. If false, image embeddings (and their mean‑pooled vector) are skipped"},"children":[]}]}]}],"default":true,"example":true},"embedText":{"type":"boolean","title":"Embedtext","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to generate embeddings for all content types. If false, text embeddings (and their mean‑pooled vector) are skipped"},"children":[]}]}]}],"default":true,"example":true},"chunkSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Chunksize","description":"The size of the text chunks to create embeddings for. If not provided, the default chunk size is used","default":256,"example":256}},"type":"object","required":["name","data","contentType","mimeType"],"title":"InputItem"}},"components/schemas/LLMModel":{"id":"components/schemas/LLMModel","kind":"json-schema","title":"LLMModel","data":{"properties":{"verbalization":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verbalization","description":"The verbalization model to use for generating explanations or text outputs.","example":"custom-verbalization-model-v1"},"text_embedding":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Embedding","description":"The text embedding model to use for generating vector embeddings from text content.","example":"custom-text-embedding-model-v1"},"image_embedding":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Embedding","description":"The image embedding model to use for generating vector embeddings from image content.","example":"custom-image-embedding-model-v1"},"dimensions":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dimensions","description":"The dimensionality of the embedding vectors produced by the specified models.","example":512}},"type":"object","title":"LLMModel","description":"Custom LLM models in the requests that override the default LLM models.","example":{"verbalization":"custom-verbalization-model-v1","text_embedding":"custom-text-embedding-model-v1","image_embedding":"custom-image-embedding-model-v1","dimensions":512}}},"components/schemas/MimeType":{"id":"components/schemas/MimeType","kind":"json-schema","title":"MimeType","data":{"type":"string","enum":["image/jpeg","image/png","application/pdf"],"title":"MimeType","description":"MIME types supported for brand review.","example":"image/png"}},"components/schemas/SearchType":{"id":"components/schemas/SearchType","kind":"json-schema","title":"SearchType","data":{"type":"string","enum":["web","knowledge"],"title":"SearchType","description":"The type of search to perform, influencing how the research prompt is processed and matched against brand content. Web search focuses on general web content, while knowledge search targets brand-related information from your brand kit.","example":"web"}},"components/schemas/Section":{"id":"components/schemas/Section","kind":"json-schema","title":"Section","data":{"properties":{"sectionId":{"type":"string","format":"uuid","title":"Sectionid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of a brand kit section whose rules are used to evaluate the input content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the section IDs, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kit sections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"example":"0b3197be-f0b7-462a-a2e5-3388a132ee3f"},"fieldIds":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Fieldids","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifiers of brand kit fields (subsections) whose rules are used to evaluate the input content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get the field IDs, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"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"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List brand kit subsections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}],"example":"8cf1b172-0277-4aa3-9bb4-252f09f148fd"}},"type":"object","required":["sectionId"],"title":"Section"}},"components/schemas/SectionReview":{"id":"components/schemas/SectionReview","kind":"json-schema","title":"SectionReview","data":{"properties":{"sectionId":{"type":"string","title":"Sectionid","description":"The unique identifier of the brand kit section whose rules were applied when evaluating the input content.","example":"0b3197be-f0b7-462a-a2e5-3388a132ee3f"},"score":{"type":"integer","maximum":5,"minimum":1,"title":"Score","description":"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},"reason":{"type":"string","title":"Reason","description":"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 improved."},"suggestion":{"type":"string","title":"Suggestion","description":"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."},"fields":{"items":{"$ref":"#/components/schemas/FieldReview"},"type":"array","title":"Fields","description":"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 could be improved.","suggestion":"Consider using more consistent terminology that aligns with the brand guidelines, and ensure that the tone remains professional throughout."}]}},"type":"object","title":"SectionReview"}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"schema_814":{"kind":"json-schema","data":{"type":"string","title":"X-Sc-Feature","example":"brand-review"},"id":"schema_814"},"schema_815":{"kind":"json-schema","data":{"type":"string","title":"X-Sc-Interaction-Type","example":"generate"},"id":"schema_815"},"schema_816":{"kind":"json-schema","data":{"type":"string","title":"X-Sc-Sellable-Product","example":"stream"},"id":"schema_816"},"schema_817":{"kind":"json-schema","data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Sc-Params","example":"feature=extraction-skills, interaction-type=extraction, sellable-product-code=ai"},"id":"schema_817"}},"exampleStore":{},"securitySchemeStore":{"HTTPBearer":{"id":"HTTPBearer","type":"http","scheme":"bearer"}},"servers":[{"url":"https://edge-platform.sitecorecloud.io/stream/ai-skills-api","description":"Production server"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ai-skills/ai-brand-review-admin-rest-api/index.json?download"},{"url":"/_bundle/ai-skills/ai-brand-review-admin-rest-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Brand Review API","description":"Use the Brand Review REST API to evaluate input content and assets against brand guidelines using AI-powered analysis.\n\nThe API analyzes content provided in the request, such as text, images, and files, by comparing it against brand kit sections for a specific tenant and organization. The analysis can evaluate content against all brand kit sections or selected sections, such as *Brand Context*, *Global Goals*, and *Tone of Voice*. SitecoreAI generates compliance scores, explanations, and improvement suggestions based on this analysis.\n\nUse this REST API to:\n- Provide content in the request body for brand evaluation against brand kit guidelines.\n- Assess how the input content aligns with specific brand kit sections and subsections (fields), including *Brand Context*, *Do’s and Don’ts*, *Tone of Voice*, *Grammar Checklists*, and *Visual Guidelines*.\n- Receive a brand compliance score for the input content on a scale from 1 to 5, where 5 indicates the highest level of alignment with the brand guidelines.\n- Evaluate multiple input formats, including text, images, PDFs, metadata, Markdown, and JSON.\n\nAfter a review is generated, teams can use the results to enforce brand consistency at scale, validate content in real time using AI-suggested improvements, and reduce compliance risk by identifying brand, legal, and accessibility issues. Compliance scores and explanations help pinpoint problem areas at the section or field level and reveal recurring trends across content.\n\nNote the following:\n- Requests typically complete within 5 seconds. Batching is not supported.\n- Multiple input formats are supported, including content from SitecoreAI or XP pages.\n- To use this REST API, you must authenticate all API requests.\n- All API requests are made in your production environment.\n\nFor more information, see the [official Sitecore documentation](https://doc.sitecore.com/).\n\n# Authorization\nThe Brand Review REST API uses the OAuth 2.0 standard with [JSON web tokens](https://doc.sitecore.com/stream/en/users/sitecore-stream/generate-a-json-web-token--jwt-.html) to authorize REST API requests.\n### Create Client ID and Client Secret\n  1. In the Sitecore Cloud Portal, open Stream.\n  2. Click **Admin** > **AI APIs keys** > **Create credential**.\n  3. In the **​Create New Client​​** dialog, enter a name and description for the client. Then click **Create**. The ​Client ID and Client Secret​​ display.\n  4. Copy the Client ID and Client Secret because you won't be able to view them again in Stream. You'll use them to request an access token.\n\n### Request an access token\nRun the following cURL command to request an access token. Replace the placeholder values with your Client ID and Client Secret.\n```curl\n  curl -X POST 'https://auth.sitecorecloud.io/oauth/token' \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n  --data-urlencode 'client_id={YOUR_API_KEY}' \\\n  --data-urlencode 'client_secret={YOUR_API_SECRET}' \\\n  --data-urlencode 'grant_type=client_credentials' \\\n  --data-urlencode 'audience=https://api.sitecorecloud.io'\n```\nIn the response, the `access_token` key contains the access token:\n```json\n  {\n    \"access_token\": \"{YOUR_ACCESS_TOKEN}\",\n    \"scope\": \"ai.orgs.br:gen ai.org.brd:w ai.org.brd:r ai.org.docs:w ai.org.docs:r ai.org:admin\",\n    \"expires_in\": 86400,\n    \"token_type\": \"Bearer\"\n  }\n```\nAccess tokens expire in 24 hours. If your requests unexpectedly return a response with status `401 Unauthorized`, request a new access token by repeating this `POST` request.\n\nWe recommend that you cache the access token for 24 hours to avoid repeating this `POST` request while the access token is still valid.\n### Include the access token in the request header\nYou can now start making REST API requests. You must include the access token in the request header of every request. For example:\n\n  ```curl\n  curl -X GET '{YOUR_BASE_URL}/v2/...' \\\n  -H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \\\n  -H 'Accept: application/json'\n  ```\n","product":"AI skills"}},"baseSlug":"/ai-skills/ai-brand-review-admin-rest-api","routesMapping":{}}