---
title: "Get Agent Branch"
method: GET
path: "/v1/convai/agents/{agent_id}/branches/{branch_id}"
tags: ["Agents Platform"]
---

# Get Agent Branch

`GET /v1/convai/agents/{agent_id}/branches/{branch_id}`

## Request

- Base URL: `https://api.elevenlabs.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.elevenlabs.io/v1/convai/agents/{agent_id}/branches/{branch_id}`
- Auth: none declared

Get information about a single agent branch

## Path parameters

- `agent_id` string, required: The id of an agent. This is returned on agent creation.
- `branch_id` string, required: Unique identifier for the branch.

## Headers

- `xi-api-key` string, nullable: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- AgentBranchResponse
  - `id` string, required
  - `name` string, required
  - `agent_id` string, required
  - `description` string, required
  - `created_at` integer, required
  - `last_committed_at` integer, required
  - `is_archived` boolean, required
  - `protection_status` 'writer_perms_required' | 'admin_perms_required'
  - `auto_rebase` boolean
  - `access_info` ResourceAccessInfo
    - `is_creator` boolean, required: Whether the user making the request is the creator of the agent
    - `creator_name` string, required: Name of the agent's creator
    - `creator_email` string, required: Email of the agent's creator
    - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required: The role of the user making the request
    - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable: The access level for anonymous users. If None, the resource is not shared publicly.
    - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable: Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
  - `current_live_percentage` number: Percentage of traffic live on the branch
  - `parent_branch` AgentBranchBasicInfo
    - `id` string, required
    - `name` string, required
  - `most_recent_versions` AgentVersionMetadata[]: Most recent versions on the branch
    - `id` string, required
    - `agent_id` string, required
    - `branch_id` string, required
    - `version_description` string, required
    - `seq_no_in_branch` integer, required
    - `time_committed_secs` integer, required
    - `parents` AgentVersionParents, required
      - `in_branch_parent_id` string, nullable
      - `out_of_branch_parent_id` string, nullable
      - `merged_into_branch_id` string, nullable
      - `merged_from_branch_id` string, nullable
      - `merged_from_version_id` string, nullable
      - `rebased_from_version_id` string, nullable
    - `access_info` ResourceAccessInfo
      - `is_creator` boolean, required: Whether the user making the request is the creator of the agent
      - `creator_name` string, required: Name of the agent's creator
      - `creator_email` string, required: Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required: The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable: The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable: Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.
    - `merged_authors` ResourceAccessInfo[], nullable: For a merge into the main branch, the people who published the merged changes on the source branch (access_info is whoever ran the merge). Null when not recorded.
      - `is_creator` boolean, required: Whether the user making the request is the creator of the agent
      - `creator_name` string, required: Name of the agent's creator
      - `creator_email` string, required: Email of the agent's creator
      - `role` 'admin' | 'editor' | 'commenter' | 'viewer', required: The role of the user making the request
      - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable: The access level for anonymous users. If None, the resource is not shared publicly.
      - `access_source` 'creator' | 'explicit' | 'workspace_admin' | 'workspace_default', nullable: Why the requesting user has access to this resource. 'creator' = caller is the owner. 'explicit' = caller (or one of their workspace groups) is listed in role_to_group_ids beyond the workspace-wide everyone group. 'workspace_default' = the workspace-wide everyone group is listed in role_to_group_ids (every non-anon workspace member, including admins, sees this resource). 'workspace_admin' = caller is a workspace admin and the admin seat is the *only* path to access; reserved for docs nobody else can see. Lets the UI disclose why an admin-bypass viewer sees a doc that wasn't explicitly shared with them.

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-11** `775d1f02f1a7`: 1 info
  - added the optional property `auto_rebase` to the response with the `200` status
- **2026-09-29** `4b83e486daca`: 1 info
  - added the optional property `most_recent_versions/items/merged_authors` to the response with the `200` status
- **2026-07-13** `009bd651509a`: 1 info
  - added the optional property `most_recent_versions/items/parents/rebased_from_version_id` to the response with the `200` status
- **2026-06-08** `37fac3c5a2d7`: 5 info
  - added the optional property `access_info/anyOf[subschema #1: ResourceAccessInfo]/access_source` to the response with the `200` status
  - added the optional property `access_info/anyOf[subschema #1: ResourceAccessInfo]/anonymous_access_level_override` to the response with the `200` status
  - added the optional property `most_recent_versions/items/access_info/anyOf[subschema #1: ResourceAccessInfo]/access_source` to the response with the `200` status
  - added the optional property `most_recent_versions/items/access_info/anyOf[subschema #1: ResourceAccessInfo]/anonymous_access_level_override` to the response with the `200` status
  - …1 more
- **2026-02-08** `5b595807512c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/changes/v1/convai/agents/:agent_id/branches/:branch_id/get.md)

---

[API](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation.md) - [All operations](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/elevenlabs/apis/elevenlabs-api-documentation/revisions/0e2bfc751634?raw)