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": "id",
  "name": "name",
  "agent_id": "agent_id",
  "description": "description",
  "created_at": 1,
  "last_committed_at": 1,
  "is_archived": true,
  "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",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "current_live_percentage": 1.1,
  "parent_branch": {
    "id": "id",
    "name": "name"
  },
  "most_recent_versions": [
    {
      "id": "id",
      "agent_id": "agent_id",
      "branch_id": "branch_id",
      "version_description": "version_description",
      "seq_no_in_branch": 1,
      "time_committed_secs": 1,
      "parents": {},
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "merged_authors": [
        {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin",
          "access_source": "creator"
        }
      ]
    }
  ]
}

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.

namestringOptional1-140 characters

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

descriptionstringOptional<=4096 characters

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

is_archivedbooleanOptional

Whether the branch should be archived

protection_statusenumOptionalDefaults to writer_perms_required

The protection level for the branch

Allowed values:

auto_rebasebooleanOptional

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_infoobjectOptional

Access information for the branch

current_live_percentagedoubleOptionalDefaults to 0

Percentage of traffic live on the branch

parent_branchobjectOptional

Parent branch of the branch

most_recent_versionslist of objectsOptional

Most recent versions on the branch

Errors

422

Branches Update Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors