Sitecore AI Agent REST API v2.0: Expanded Capabilities and Upcoming Deprecations
In This Article
Sitecore has released Agent REST API v2.0, introducing several new endpoints that enhance experimentation, personalization, flow management, and brief handling. The update also marks the beginning of the retirement process for selected v1.0 endpoints, giving developers time to migrate to the latest APIs.
What's New in Agent REST API v2.0?
The latest version delivers a more comprehensive framework for managing content optimization and personalization workflows. Developers can now create and manage A/B/n experiments, configure flow definitions, and work with updated personalization and brief management APIs.
Future-Proof Your Sitecore AI
Modernize AI workflows, personalization, experiments, and integrations with scalable Sitecore API strategies built for upcoming platform changes.
Enhanced Experiment Management
A new set of experiment endpoints enables the creation and maintenance of component-level A/B/n testing experiences.
Available endpoints:
- POST /api/v1/experiments/flows – Create a new component A/B/n test.
- PUT /api/v1/experiments/{flowId} – Update an existing component A/B/n test.
These additions provide greater flexibility for teams looking to optimize page components through controlled experimentation.
Personalization API Improvements
Version 2.0 introduces dedicated endpoints for creating and managing personalization variants on a page.
New endpoints:
- POST /api/v2/personalization/{pageId}/versions – Create a personalization variant.
- GET /api/v2/personalization/{pageId}/versions – Retrieve personalization variants for a page.
- PUT /api/v1/personalization/{pageId}/versions/{variantId} – Update a personalization variant.
The new version streamlines personalization workflows while providing a more scalable foundation for future enhancements.
Start Your Digital Growth Journey
Flow Definition Management
Developers can now retrieve and configure flow definitions more effectively using a dedicated set of endpoints.
Available endpoints:
- GET /api/v1/flows/by-page/{pageId} – List all flow definitions associated with a page.
- GET /api/v1/flows/{flowId} – Retrieve flow definition details.
- GET /api/v1/flows/{flowId}/variants/{variantId} – Retrieve a specific variant.
- POST /api/v1/flows/{flowId}/variants/{variantId} – Configure a flow definition variant.
These APIs simplify the management of both personalization experiences and A/B testing configurations.
Expanded Brief Management
The release also introduces new capabilities for retrieving and updating briefs and brief type definitions.
Available endpoints:
- GET /api/v1/brief/brief-types/{brief_type_id} – Retrieve a brief type.
- GET /api/v1/brief – List all briefs.
- GET /api/v1/brief/{brief_id} – Retrieve a specific brief.
- PUT /api/v1/brief/{brief_id} – Update a brief.
This enhancement improves content planning workflows by providing greater control over brief management.
Deprecated Endpoints and Migration Timeline
While existing v1.0 endpoints remain operational for now, Sitecore has announced their future removal.
Personalization v1.0 Deprecation
The following endpoints will be deprecated and removed on August 4, 2026:
- GET /api/v1/personalization/by-page/{pageId}
- POST /api/v1/personalization/{pageId}/versions
Recommended action: Migrate to the new v2.0 personalization create and list endpoints.
Brief Generation Endpoint Deprecation
The following endpoint will be deprecated and removed on September 20, 2026:
- POST /api/v1/briefs/generate
Recommended action: Transition to the newly introduced brief generation endpoint before the retirement date.
Final Thoughts
Agent REST API v2.0 represents a significant step forward in Sitecore's AI-driven content optimization ecosystem. The addition of experiment management, enhanced personalization capabilities, flow definition controls, and improved brief management provides developers with a more robust and future-ready API set. Organizations currently using the older endpoints should begin planning their migration strategy to ensure uninterrupted functionality ahead of the announced deprecation deadlines.
Reference:
Sitecore AI Agent API v2.0 Release and Endpoint Updates
Frequently Asked Questions
What is Sitecore AI Agent REST API v2.0?
Sitecore AI Agent REST API v2.0 is an updated API release that expands programmatic capabilities for component-level A/B/n experiments, page personalization, flow definitions, briefs, and AI-driven content workflows.
What new features were added in Sitecore Agent API v2.0?
Agent API v2.0 introduced new endpoints for creating and updating component-level A/B/n experiments, creating and listing personalization variants, retrieving and configuring flow definitions, and retrieving and updating briefs.
How does Sitecore Agent API v2.0 support A/B/n testing?
The API includes endpoints for creating and updating component-level A/B/n experiment flows. This allows developers to programmatically manage experiments and optimize individual page components.
What changed in the Sitecore Personalization API?
Sitecore introduced v2.0 endpoints for creating and listing personalization variants for a page. Developers should use the newer v2 personalization endpoints instead of the deprecated v1 create and list workflows.
Which Sitecore personalization API endpoints were deprecated?
The deprecated endpoints are GET /api/v1/personalization/by-page/{pageId} and POST /api/v1/personalization/{pageId}/versions. Their scheduled removal date was August 4, 2026.
What is the Sitecore Flow Definition API?
The Flow Definition API allows developers to retrieve flow definitions for a page, access individual flow details, retrieve specific variants, and configure flow variants for personalization and A/B/n testing.
What brief management capabilities are available in Agent API v2.0?
Agent API v2.0 supports retrieving brief types, listing briefs, retrieving individual briefs, and updating briefs, giving developers greater programmatic control over content planning workflows.
Which Sitecore brief generation endpoint is being deprecated?
The POST /api/v1/briefs/generate endpoint is scheduled for deprecation and removal on September 20, 2026. Developers should migrate to the newer generate brief endpoint before that deadline.
How should developers migrate to Sitecore Agent API v2.0?
Developers should identify legacy API calls, replace deprecated personalization workflows with the v2 create and list endpoints, migrate the legacy brief generation workflow, test integrations, and validate all API changes before production deployment.
Why is Sitecore Agent API v2.0 important for enterprise developers?
Sitecore Agent API v2.0 provides more structured API access to experiments, personalization, flow configuration, and content briefs, helping enterprise teams automate and integrate modern AI-driven digital experience workflows.
