Retrieve the page preview URL

Request

Retrieves the preview URL for a specific page.

Security

HTTPBearer

Path

pageIdstring, (uuid)(Pageid)required

The unique identifier of the page. To get this ID, use List pages of a site.

Example:550e8400-e29b-41d4-a716-446655440000

Query

languagestring(Language)

The language code for the page content.

Default:"en"

Example:language=en

versioninteger or null(Version)

Example:version=1

Any of:

The version number of the page to retrieve the preview URL for.

integer

variantIdstring or null(Variantid)

Example:variantId=8bd7a9ec96b8490f9b894e3866fefb79_2a5c1e8c8d244f569a44d6b28cbecb05

Any of:

The unique identifier of the personalization or A/B/n test variant to preview. To get this ID, you can use the List flow definitions endpoint. Use the transpiledVariants[].ref, or variants[].ref when available.

If you provide this value, the preview URL is retrieved for the specified variant. If you omit this value, the preview URL for the base page is returned.

string

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/pages/550e8400-e29b-41d4-a716-446655440000/preview-url?language=en&version=1&variantId=8bd7a9ec96b8490f9b894e3866fefb79_2a5c1e8c8d244f569a44d6b28cbecb05' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json

pageIdstring, (uuid)(Pageid)

The unique identifier of the page.

Example:"f0b81bcc-7388-46be-b109-6e73d1114470"

previewUrlstring, (uri), [ 1 .. 2083 ] characters(Previewurl)

The preview URL of the page.

Example:"https://preview.example.com/page/f0b81bc-7388-46be-b109-6e73d1114470"

Response

{
  "pageId": "f0b81bcc-7388-46be-b109-6e73d1114470",
  "previewUrl": "https://preview.example.com/page/f0b81bc-7388-46be-b109-6e73d1114470"
}