Sitecore API catalog/Agent API/
/
Create a brief

Create a brief

Request

Creates a brief using the specified brief type ID, locale, and provided data fields. The new brief is saved as a draft 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
namestring(Name)required

The name of the brief.

Example:"New Summer Campaign Brief"
localestring(Locale)^[a-zA-Z]{2}-[a-zA-Z]{2}$required

The locale code associated with the brief, in the format xx-XX.

Example:"en-us"
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"
fieldsobject or null(Fields)
Example:
{
  "Objectives": {
    "type": "RichText",
    "value": "New product campaign launch for Summer 2026."
  },
  "TargetAudience": {
    "type": "RichText",
    "value": "Millenials"
  }
}
Any of:

Dictionary of field names to their values.

curl -i -X POST \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brief \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-sc-job-id: job-1234' \
  -d '{
    "name": "New Summer Campaign Brief",
    "locale": "en-us",
    "briefTypeId": "e7fe656b-178e-4ee2-86a9-ec800ff8a31d",
    "fields": {
      "Objectives": {
        "type": "RichText",
        "value": "New product campaign launch for Summer 2026."
      },
      "TargetAudience": {
        "type": "RichText",
        "value": "Millenials"
      }
    }
  }'

Responses

Successful response

Bodyapplication/json
idstring(Id)

The unique identifier of the created brief.

Example:"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
iconstring or null(Icon)
Any of:

The icon associated with the brief.

string
namestring(Name)

The name of the brief.

Example:"New Summer Campaign Brief"
statusstring(Status)

The status of the brief. Draft by default.

Example:"Draft"
localestring(Locale)

The locale code in the format xx-XX.

Example:"en-us"
fieldsobject(Fields)

Dictionary of field names to their values.

Example:
{
  "Objectives": {
    "type": "RichText",
    "value": "New product campaign launch for Summer 2026."
  },
  "TargetAudience": {
    "type": "RichText",
    "value": "Millenials"
  }
}
isTemplateboolean or null(Istemplate)
Example:false
Any of:

Whether the brief is a template

boolean
contributorsArray of strings or null(Contributors)
Any of:

A list of users who are contributors to the brief, or null if no contributors.

Array of strings
createdByExternalLink (object) or null
Any of:

Represents an external link with reference to external systems

createdOnstring or null(Createdon)
Example:"2026-01-15T10:30:00Z"
Any of:

The ISO 8601 timestamp when the brief was created.

string
updatedByExternalLink (object) or null
Any of:

Represents an external link with reference to external systems

updatedOnstring or null(Updatedon)
Example:"2026-04-01T08:00:00Z"
Any of:

The ISO 8601 timestamp when the brief was last updated.

string
Response
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "icon": "string",
  "name": "New Summer Campaign Brief",
  "status": "Draft",
  "locale": "en-us",
  "fields": {
    "Objectives": { … },
    "TargetAudience": { … }
  },
  "isTemplate": false,
  "contributors": [
    "string"
  ],
  "createdBy": {
    "type": "ExternalLink",
    "relatedSystem": "ai",
    "relatedType": "Dashboard",
    "id": "dashboard-12345"
  },
  "createdOn": "2026-01-15T10:30:00Z",
  "updatedBy": {
    "type": "ExternalLink",
    "relatedSystem": "ai",
    "relatedType": "Dashboard",
    "id": "dashboard-12345"
  },
  "updatedOn": "2026-04-01T08:00:00Z"
}