Update agent branch | ElevenLabs Documentation

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
async function main() {
    const client = new ElevenLabsClient();
    await client.conversationalAi.agents.branches.update("agent_3701k3ttaq12ewp8b7qv5rfyszkz", "agtbranch_0901k4aafjxxfxt93gd841r7tv5t", {});
}
main();

{
  "id": "agtbranch_0901k4aafjxxfxt93gd841r7tv5t",
  "name": "Feature Update Branch",
  "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
  "description": "Branch for implementing new conversational features",
  "created_at": 1685600000,
  "last_committed_at": 1685700000,
  "is_archived": false,
  "protection_status": "writer_perms_required",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin"
  },
  "current_live_percentage": 75.5,
  "parent_branch": {
    "id": "agtbranch_0801j3aafjxxfxt93gd841r7tv5s",
    "name": "Main Branch"
  },
  "most_recent_versions": [
    {
      "id": "ver_20240601001",
      "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
      "branch_id": "agtbranch_0901k4aafjxxfxt93gd841r7tv5t",
      "version_description": "Added new dialogue intents and improved response accuracy",
      "seq_no_in_branch": 5,
      "time_committed_secs": 1685690000,
      "parents": {},
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin"
      }
    }
  ]
}

Update agent branch properties such as archiving status and protection level

Path parameters

agent_idstringRequired

The id of an agent. This is returned on agent creation.

branch_idstringRequired

Unique identifier for the branch.

Request

This endpoint expects an object.

namestringOptional1-140 characters

New name for the branch. Must be unique within the agent.

is_archivedbooleanOptional

Whether the branch should be archived

protection_statusenumOptionalDefaults to writer_perms_required

The protection level for the branch

Allowed values:

Response

Successful Response

idstring

namestring

agent_idstring

descriptionstring

created_atinteger

last_committed_atinteger

is_archivedboolean

protection_statusenumDefaults to writer_perms_required

Allowed values:

access_infoobject

Access information for the branch

current_live_percentagedoubleDefaults to 0

Percentage of traffic live on the branch

parent_branchobject

Parent branch of the branch

most_recent_versionslist of objects

Most recent versions on the branch

Errors

422

Branches Update Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors