Update agent branch

PATCH

/v1/convai/agents/:agent_id/branches/:branch_id

PATCH

/v1/convai/agents/:agent_id/branches/:branch_id

curl -X PATCH https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches/agtbranch_0901k4aafjxxfxt93gd841r7tv5t \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "agtbranch_0901k4aafjxxfxt93gd841r7tv5t",
  "name": "feature/improved-greeting-flow",
  "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
  "description": "Branch for testing improved greeting and onboarding conversation flow",
  "created_at": 1718000000,
  "last_committed_at": 1718086400,
  "is_archived": false,
  "protection_status": "writer_perms_required",
  "auto_rebase": true,
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "access_source": "creator"
  },
  "current_live_percentage": 15.5,
  "parent_branch": {
    "id": "agtbranch_main01k4aafjxxfxt93gd841r7tv5t",
    "name": "main"
  },
  "most_recent_versions": [
    {
      "id": "agtver_1201k4aafjxxfxt93gd841r7tv5t",
      "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
      "branch_id": "agtbranch_0901k4aafjxxfxt93gd841r7tv5t",
      "version_description": "Updated greeting prompt and added fallback responses for unrecognized intents",
      "seq_no_in_branch": 3,
      "time_committed_secs": 1718086400,
      "parents": {
        "in_branch_parent_id": "agtver_1101k4aafjxxfxt93gd841r7tv5t",
        "out_of_branch_parent_id": "agtver_main01k4aafjxxfxt93gd841r7tv5t",
        "merged_into_branch_id": null,
        "merged_from_branch_id": null,
        "merged_from_version_id": null,
        "rebased_from_version_id": "agtver_main01k4aafjxxfxt93gd841r7tv5t"
      },
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "merged_authors": [
        {
          "is_creator": false,
          "creator_name": "Jane Smith",
          "creator_email": "jane.smith@example.com",
          "role": "editor",
          "anonymous_access_level_override": null,
          "access_source": "explicit"
        }
      ]
    }
  ]
}

Update agent branch properties such as name, description, archiving status, protection level, and auto-rebase onto main

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.

namestring or nullOptional1-140 characters

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

descriptionstring or nullOptional<=4096 characters

New description for the branch. Pass an empty string to clear it.

is_archivedboolean or nullOptional

Whether the branch should be archived

protection_statusenum or nullOptionalDefaults to writer_perms_required

The protection level for the branch

Allowed values:

auto_rebaseboolean or nullOptional

When true, rebase this branch onto main automatically after each new main version. Cannot be enabled on the main branch.

Response

Successful Response

idstring

namestring

agent_idstring

descriptionstring

created_atinteger

last_committed_atinteger

is_archivedboolean

protection_statusenumOptionalDefaults to writer_perms_required

Allowed values:

auto_rebasebooleanOptionalDefaults to false

access_infoobject or nullOptional

Access information for the branch

current_live_percentagedoubleOptionalDefaults to 0

Percentage of traffic live on the branch

parent_branchobject or nullOptional

Parent branch of the branch

most_recent_versionslist of objectsOptional

Most recent versions on the branch

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors