Recording pending: Review and publish a configuration version. Follow the written guide below.
Know the identifiers
Create agent returns
agent_id, main_branch_id, and initial_version_id. Keep these identifiers when creating subsequent requests.
Dashboard working copy
The editor keeps a local working copy while you edit. Review its changes against the latest published version before selecting Publish. In Review Changes, confirm the branch, add a Commit message, and publish the reviewed diff. A local working copy is not the same resource as a server draft created through the API. Do not assume an unsubmitted editor change is available to another teammate or integration.API workflow
1
Select the branch
Read the agent and identify the intended branch. To create a branch, provide
name, description, and parent_version_id through Create agent branch.2
Prepare the complete draft
Use Create agent draft with an explicit
branch_id query parameter. A draft is a configuration snapshot containing the agent name, conversation_config, platform_settings, and workflow.Start from the selected version and preserve fields you are not changing. Do not treat a complete draft snapshot as a small partial patch.3
Review before publication
Compare the draft with the branch’s current published configuration. Review models, knowledge, tool references, and workflow changes as well as the prompt.When combining branch changes, inspect merge preview or rebase preview before applying them.
4
Publish and read back
Use Update agent with an explicit
branch_id query parameter and a useful version_description.To commit the saved server draft, send a body containing only version_description. A request containing other configuration fields publishes those submitted changes from the branch’s published tip; it does not commit the saved draft. Review which workflow you intend before sending the request.Read the agent and version metadata back. Confirm the branch, resulting version, and reviewed settings.
Screenshot pending: Review Changes with a sample configuration diff and the selected branch.
Traffic deployment is currently gated in the documented implementation. Publishing a configuration version does not route live conversations to it. See current availability.
Discarding and reconciling changes
Use Delete agent draft to remove the server draft for the selected branch. Dashboard Discard changes operates on the editor’s working copy. Check which kind of draft you are changing before discarding it. If the published version changes while you edit, review the newer version and reconcile your pending changes before publication. Keep a short version description that explains the intended behavior rather than listing only the fields changed.Review checklist
Confirm the workspace and branch, inspect the complete diff, check referenced resources, and read the published version back. Retain the agent, branch, and version IDs with any later runtime test evidence so you can identify exactly which configuration was assessed.Frequently asked questions
Is the editor working copy a server draft?
Is the editor working copy a server draft?
No. The editor keeps local pending changes. An API server draft is a separate stored resource on a selected branch.
How do I commit the saved server draft?
How do I commit the saved server draft?
Select branch_id explicitly and send a PATCH body containing only version_description. Other configuration fields publish submitted changes from the branch tip.
Does a published version allocate live traffic?
Does a published version allocate live traffic?
No. A version identifies saved configuration. Traffic allocation and runtime execution require a separate supported path.