Logo
Skip to main content
The Agent API v2.0 release and endpoint updates page has loaded.

SitecoreAI Changelog

Learn more about new versions, changes and improvements for SitecoreAI

Agent API v2.0 release and endpoint updates

SitecoreAISitecoreAI
New featureImprovement

The Agent REST API v2.0 introduces new endpoints for experiments, personalization, briefs, and flow definitions, along with deprecated v1.0 personalization endpoints and a breaking change to the brief generation path.

New endpoints

  • Experiments - use these endpoints to create and update component-level A/B/n tests:

    • POST /api/v1/experiments/flows - create a new component A/B/n test.

    • PUT /api/v1/experiments/{flowId} - update a component A/B/n test.

  • Personalization - use these endpoints to create, list, and update personalization variants for a page:

    • POST /api/v2/personalization/{pageId}/versions - create a personalization variant (v2.0).

    • GET /api/v2/personalization/{pageId}/versions - list personalization variants (v2.0).

    • PUT /api/v1/personalization/{pageId}/versions/{variantId} - update a personalization variant.

  • Flow definitions - use these endpoints to retrieve and configure flow definitions (personalizations and A/B/n tests):

    • GET /api/v1/flows/by-page/{pageId} - list all flow definitions (A/B tests and personalization) for a page.

    • GET /api/v1/flows/{flowId} - retrieve flow definition details by ID.

    • GET /api/v1/flows/{flowId}/variants/{variantId} - retrieve a specific flow definition variant.

    • POST /api/v1/flows/{flowId}/variants/{variantId} - configure a flow definition variant.

  • Briefs - use these endpoints to retrieve and update briefs and brief type definitions:

    • GET /api/v1/brief/brief-types/{brief_type_id} - retrieve a brief type by ID.

    • GET /api/v1/brief List briefs - retrieve all available briefs.

    • GET /api/v1/brief/{brief_id} - retrieve a brief by ID.

    • PUT /api/v1/brief/{brief_id} - update a brief.

Deprecated V1 endpoints

These endpoints are being maintained for backward compatibility but are scheduled for deprecation and removal.

  • Personalization v1.0 endpoints - these endpoints will be deprecated and removed on August 4, 2026:

    • GET /api/v1/personalization/by-page/{pageId}

    • POST /api/v1/personalization/{pageId}/versions
      Migration guidance: Use the create and list personalization v2.0 endpoints moving forward.

  • Brief generation endpoint - the following endpoint will be deprecated and removed on September 20, 2026:

    • POST /api/v1/briefs/generate
      Migration guidance: Use the new generate brief endpoint moving forward.

Read more