List agent branches

GET

/v1/convai/agents/:agent_id/branches

GET

/v1/convai/agents/:agent_id/branches

1 from elevenlabs import ElevenLabs
2 
3 client = ElevenLabs(
4     base_url="https://api.elevenlabs.io"
5 )
6 
7 client.conversational_ai.agents.branches.list(
8     agent_id="agent_id"
9 )

Try it

200Retrieved

1 {
2   "results": [
3     {
4       "id": "branch_9f8d7c6b5a4e3d2c1b0a",
5       "name": "Development",
6       "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
7       "description": "Main development branch for new features",
8       "created_at": 1688006400,
9       "last_committed_at": 1688592000,
10       "is_archived": false,
11       "protection_status": "writer_perms_required",
12       "access_info": {
13         "is_creator": true,
14         "creator_name": "John Doe",
15         "creator_email": "john.doe@example.com",
16         "role": "admin"
17       },
18       "current_live_percentage": 75.5,
19       "draft_exists": true
20     },
21     {
22       "id": "branch_1a2b3c4d5e6f7g8h9i0j",
23       "name": "Feature-X",
24       "agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
25       "description": "Experimental branch for feature X testing",
26       "created_at": 1687500000,
27       "last_committed_at": 1688000000,
28       "is_archived": true,
29       "protection_status": "admin_perms_required",
30       "access_info": {
31         "is_creator": false,
32         "creator_name": "Jane Smith",
33         "creator_email": "jane.smith@example.com",
34         "role": "editor"
35       },
36       "current_live_percentage": 0,
37       "draft_exists": false
38     }
39   ],
40   "meta": {
41     "total": 2,
42     "page": 1,
43     "page_size": 2
44   }
45 }

Returns a list of branches an agent has

Path parameters

agent_idstringRequired

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

Query parameters

include_archivedbooleanOptionalDefaults to false

Whether archived branches should be included

limitintegerOptional<=100Defaults to 100

How many results at most should be returned

Response

Successful Response

resultslist of objects

metaobject or null

List agent branches

Path parameters

Headers

Query parameters

Response

Errors