Implementation:Elevenlabs Elevenlabs python AgentBranchSummary

Field	Value
source	Elevenlabs_Elevenlabs_python
domains	Conversational AI, Agent Branching, Version Control
last_updated	2026-02-15

Overview

Description

AgentBranchSummary is a Pydantic model that represents a summary of an agent branch in the ElevenLabs Conversational AI platform. Agent branches enable version control and A/B testing workflows for conversational agents, allowing developers to maintain multiple configurations of an agent simultaneously.

This model is auto-generated by Fern from the ElevenLabs API definition and inherits from UncheckedBaseModel. It includes essential metadata about a branch such as its identity, protection status, traffic allocation, and draft state.

Usage

AgentBranchSummary is returned by the ElevenLabs API when listing or retrieving branch information for an agent. It provides a compact view of branch state for use in branch management interfaces and API responses.

Code Reference

Source Location

src/elevenlabs/types/agent_branch_summary.py

Class Signature

class AgentBranchSummary(UncheckedBaseModel):
    ...

Import Statement

from elevenlabs.types import AgentBranchSummary

I/O Contract

Field	Type	Required	Description
`id`	`str`	Yes	The unique identifier of the branch.
`name`	`str`	Yes	The name of the branch.
`agent_id`	`str`	Yes	The ID of the agent this branch belongs to.
`description`	`str`	Yes	A description of the branch.
`created_at`	`int`	Yes	Timestamp of when the branch was created.
`last_committed_at`	`int`	Yes	Timestamp of the last commit on this branch.
`is_archived`	`bool`	Yes	Whether the branch has been archived.
`protection_status`	`Optional[BranchProtectionStatus]`	No	The protection status of the branch.
`access_info`	`Optional[ResourceAccessInfo]`	No	Access information for the branch.
`current_live_percentage`	`Optional[float]`	No	Percentage of traffic live on the branch.
`draft_exists`	`Optional[bool]`	No	Whether a draft exists for the branch.

Usage Examples

Inspecting a Branch Summary

from elevenlabs.types import AgentBranchSummary

# Typically received from an API response
branch = AgentBranchSummary(
    id="branch_abc123",
    name="experiment-v2",
    agent_id="agent_xyz789",
    description="Experimental prompt changes for improved engagement",
    created_at=1700000000,
    last_committed_at=1700100000,
    is_archived=False,
    current_live_percentage=25.0,
    draft_exists=True,
)

print(f"Branch '{branch.name}' is serving {branch.current_live_percentage}% of traffic")

Filtering Active Branches

# Given a list of branch summaries from an API response
active_branches = [b for b in branches if not b.is_archived]
live_branches = [b for b in active_branches if b.current_live_percentage and b.current_live_percentage > 0]

Related Pages

Elevenlabs_Elevenlabs_python_GetAgentResponseModel - Full agent response model that includes branch information
Elevenlabs_Elevenlabs_python_AgentConfig - Core agent configuration within a branch

Page Connections

Double-click a node to navigate. Hold to expand connections.

Principle

Implementation

Heuristic

Environment