GET
/v1/convai/agents/{agent_id}/branches
ElevenLabs APIList Agent Branches
- Base URL
- https://api.elevenlabs.io
- Auth
- xi-api-key: <ELEVENLABS_API_KEY>
- Last verified
- 2026-09-03 · upstream hash matched
Actions
Agents: curl -H "Accept: text/markdown" this URL
→ 207 tokens · Vary: Accept
→ 207 tokens · Vary: Accept
Critical gotchas
Authentication uses the non-standard xi-api-key header, not Authorization: Bearer. Sending a Bearer token returns HTTP 401.
Text-to-speech responses are raw binary audio, not JSON. Write the body to a file (--output speech.mp3) rather than parsing it.
cURL
curl -X GET 'https://api.elevenlabs.io/v1/convai/agents/agent-id/branches?include_archived=false&limit=100&include_commit_status=false' \ -H "xi-api-key: $ELEVENLABS_API_KEY"Get a free ElevenLabs API key → sponsored
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| agent_id | path | string | Yes | The id of an agent. This is returned on agent creation. |
| include_archived | query | boolean | No | Whether archived branches should be included |
| limit | query | integer | No | How many results at most should be returned |
| include_commit_status | query | boolean | No | Whether to compute how far each branch has diverged from main (commits_ahead/commits_behind). This walks the version DAG of every branch, so it is slow on agents with long histories and is off by default, leaving those fields null. |
Response 200 OK
{
"meta": {
"total": 0,
"page": 0,
"page_size": 0
},
"results": [
{
"id": "string",
"name": "string",
"agent_id": "string",
"description": "string",
"created_at": 0,
"last_committed_at": 0,
"is_archived": true,
"protection_status": "writer_perms_required",
"access_info": {
"access_source": "creator",
"creator_email": "john.doe@example.com",
"creator_name": "John Doe",
"is_creator": true,
"role": "admin"
},
"current_live_percentage": 0,
"parent_branch_id": "string",
"draft_exists": false,
"calls_7d": 0,
"commits_ahead": 0,
"commits_behind": 0,
"merged_into_branch_id": "string"
}
]
}