Sitecore API catalog/Agent API/
/
Generate a brief

Generate a brief

Request

Generates a brief draft and the content of its fields, using the specified brief type, brand kit, and prompt. This endpoint does not save the generated draft. You can copy the response and use the Create a brief endpoint to save it in the Brief management tool.

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
Bodyapplication/jsonrequired
briefTypeIdstring(Brieftypeid)required

The unique identifier of the brief type to use for generating a brief. To get this ID, you can use the List brief types endpoint to retrieve the list of brief types available in your organization.

Example:"e7fe656b-178e-4ee2-86a9-ec800ff8a31d"
brandIdstring(Brandid)required

The unique identifier of the brand kit. To get this ID, you can use the List brand kits endpoint to retrieve the list of brand kits in your organization.

Example:"b1234567-89ab-4cde-f012-3456789abcde"
promptstring(Prompt)required

The prompt for brief generation. This provides AI the context or instructions for generating the brief.

Example:"Generate a brief for the new holiday campaign."
curl -i -X POST \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brief/generate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-sc-job-id: job-1234' \
  -d '{
    "briefTypeId": "e7fe656b-178e-4ee2-86a9-ec800ff8a31d",
    "brandId": "b1234567-89ab-4cde-f012-3456789abcde",
    "prompt": "Generate a brief for the new holiday campaign."
  }'

Responses

Successful response

Bodyapplication/json
property name*object(BriefFieldValue)additional property

Model for individual brief field values.

Response
{
  "property1": {
    "label": "Objectives",
    "type": "RichText",
    "value": "The holiday campaign aims to inspire and empower audiences to embrace a healthier and more energetic lifestyle."
  },
  "property2": {
    "label": "Objectives",
    "type": "RichText",
    "value": "The holiday campaign aims to inspire and empower audiences to embrace a healthier and more energetic lifestyle."
  }
}