Sitecore API catalog/Agent API/Briefs

Briefs

The Briefs API lets you retrieve available brief types, generate briefs based on a brief type and brand kit, create briefs and save it as a draft, and retrieve details of a specific brief.

Operations

List brief types

Request

Retrieves a list of available brief types, including their metadata and field definitions such as field types, labels, validation rules, and other information used by AI when generating briefs.

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/brief/brief-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json
totalCountinteger(Totalcount)

The total number of available brief types.

Example:5
dataArray of objects(Data)

A list of available brief types.

Response
{
  "totalCount": 5,
  "data": [
    { … }
  ]
}