Sitecore API catalog/Agent API/Pages

Pages

The Pages API lets you create new pages, add new language versions or components to a page, search for pages on a site, set the component datasource on a page, retrieve page components, paths, HTML, preview URL, screenshots, templates, details, and allowed components.

Operations

Create a page

Request

Creates a new page using the specified template under the parent page. You can set field values and the language for the new page.

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
templateIdstring, (uuid)(Templateid)required

The unique identifier of the page template to be used for the new page.

Example:"9f8c7e6d-5b4a-4c3d-8e7f-1a2b3c4d5e6f"
namestring(Name)required

The name of the page to create.

Example:"About Us"
parentIdstring, (uuid)(Parentid)required

The unique identifier of the parent item for the new page.

Example:"3f2504e0-4f89-11d3-9a0c-0305e82c3301"
languagestring(Language)

The language code for the new page.

Default:"en"
Example:"en"
fieldsArray of objects or null(Fields)
Any of:

A list of field objects to set on the page, or null if none.

curl -i -X POST \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/pages/create \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-sc-job-id: job-1234' \
  -d '{
    "templateId": "9f8c7e6d-5b4a-4c3d-8e7f-1a2b3c4d5e6f",
    "name": "About Us",
    "parentId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
    "language": "en",
    "fields": [
      {}
    ]
  }'

Responses

Successful response

Bodyapplication/json
itemIdstring, (uuid)(Itemid)

The unique identifier of the created page.

Example:"3f2504e0-4f89-11d3-9a0c-0305e82c3301"
namestring(Name)

The name of the created page.

Example:"About Us"
Response
{
  "itemId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
  "name": "About Us"
}