Sitecore API catalog/Agent API/Brand kits

Brand kits

The Brand kits API lets you retrieve a list of brand kits and details of a specific brandkit.

Operations

List brand kits

Request

Retrieves all brand kits available within an organization.

Security
HTTPBearer
Headers
x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234
curl -i -X GET \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brandkits \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json
Array [
idstring, (uuid)(Id)

The unique identifier of the brand kit.

Example:"b1234567-89ab-4cde-f012-3456789abcde"
namestring(Name)

The name of the brand kit.

Example:"Contoso Brand Kit"
descriptionstring or null(Description)
Example:"Brand kit for Contoso Corporation."
Any of:

The brand kit description.

string
brandNamestring or null(Brandname)
Example:"Contoso"
Any of:

The name of the brand associated with the brand kit. Returns null if no brand name is set.

string
companyNamestring or null(Companyname)
Example:"Contoso Corporation"
Any of:

The name of the company associated with the brand kit. Returns null if no company name is set.

string
statusstring(Status)

The status of the brand kit.

Example:"published"
tagsArray of objects or null(Tags)
Any of:

A list of tags associated with the brand kit.

]
Response
[
  {
    "id": "b1234567-89ab-4cde-f012-3456789abcde",
    "name": "Contoso Brand Kit",
    "description": "Brand kit for Contoso Corporation.",
    "brandName": "Contoso",
    "companyName": "Contoso Corporation",
    "status": "published",
    "tags": []
  }
]