> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Listar branches do agente

GET https://api.elevenlabs.io/v1/convai/agents/{agent_id}/branches

Retorna uma lista de branches de um agente

Reference: https://elevenlabs.io/docs/api-reference/agents/branches/list

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Path parameters

- `agent_id` (string, required) — O ID de um agente. Ele é retornado na criação do agente.

### Query parameters

- `include_archived` (boolean, optional, default: false) — Se as branches arquivadas devem ser incluídas.
- `limit` (integer, optional, default: 100) — Quantidade máxima de resultados a retornar
- `include_commit_status` (boolean, optional, default: false) — Indica se deve calcular o quanto cada ramificação divergiu da principal (commits_ahead/commits_behind). Isso percorre o DAG de versões de cada ramificação, portanto é lento em agentes com históricos longos e fica desativado por padrão, deixando esses campos como null.

## Response

### 200

Resposta bem-sucedida

- `results` (list of AgentBranchSummary, required)
- `meta` (ListResponseMeta, optional)

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### AgentBranchSummary

- `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` (enum, optional, default: writer_perms_required)
  - Allowed values: `writer_perms_required`, `admin_perms_required`
- `auto_rebase` (boolean, optional, default: false)
- `access_info` (ResourceAccessInfo, optional, nullable) — Informações de acesso para a ramificação
- `current_live_percentage` (double, optional, default: 0) — Porcentagem do tráfego ativo na branch
- `parent_branch_id` (string, optional, nullable) — ID da ramificação pai
- `draft_exists` (boolean, optional, default: false) — Se existe um rascunho para a branch.
- `draft_created_at` (integer, optional, nullable) — Segundos Unix em que o rascunho do chamador nesta ramificação foi criado pela primeira vez, ou null quando não houver rascunho. Um rascunho criado antes de last_committed_at foi escrito com base em uma configuração que a ramificação já ultrapassou e, portanto, pode não refletir a configuração atual.
- `draft_is_behind_tip` (boolean, optional, default: false) — Se o rascunho de quem fez a chamada nesta branch foi criado antes do último commit da branch, o que significa que foi escrito com base em uma configuração que a branch já ultrapassou e talvez não reflita a atual.
- `calls_7d` (integer, optional, default: 0) — Número de chamadas nos últimos 7 dias
- `commits_ahead` (integer, optional, nullable) — Número de commits nesta ramificação que ainda não estão em main, em relação ao ancestral comum. Nulo se não puder ser calculado (por exemplo, sem ancestral comum ou se o histórico da ramificação exceder o limite de comparação).
- `commits_behind` (integer, optional, nullable) — Número de commits em main que ainda não foram incorporados a esta ramificação, em relação ao ancestral comum. Nulo se não puder ser calculado (por exemplo, sem ancestral comum ou se o histórico da ramificação exceder o limite de comparação).
- `merged_into_branch_id` (string, optional, nullable) — ID da ramificação na qual a versão mais recente desta ramificação foi mesclada, se houver

### ListResponseMeta

- `total` (integer, optional, nullable)
- `page` (integer, optional, nullable)
- `page_size` (integer, optional, nullable)

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### ResourceAccessInfo

- `is_creator` (boolean, required) — Indica se o usuário que faz a solicitação é o criador do agente
- `creator_name` (string, required) — Nome do criador do agente
- `creator_email` (string, required) — E-mail do criador do agente
- `role` (enum, required) — A função do usuário que faz a solicitação
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional, nullable) — O nível de acesso para usuários anônimos. Se for None, o recurso não será compartilhado publicamente.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional, nullable) — Por que o usuário solicitante tem acesso a este recurso. 'creator' = o chamador é o proprietário. 'explicit' = o chamador (ou um dos grupos do workspace dele) está listado em role_to_group_ids além do grupo everyone de todo o workspace. 'workspace_default' = o grupo everyone de todo o workspace está listado em role_to_group_ids (todos os membros não anônimos do workspace, incluindo administradores, veem este recurso). 'workspace_admin' = o chamador é administrador do workspace e a função de administrador é o *único* caminho de acesso; reservado para documentos que ninguém mais pode ver. Permite que a interface revele por que um visualizador com desvio de administrador vê um documento que não foi compartilhado explicitamente com ele.
  - Allowed values: `creator`, `explicit`, `workspace_admin`, `workspace_default`

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "results": [
    {
      "id": "string",
      "name": "string",
      "agent_id": "string",
      "description": "string",
      "created_at": 1,
      "last_committed_at": 1,
      "is_archived": true,
      "protection_status": "writer_perms_required",
      "auto_rebase": false,
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "current_live_percentage": 0,
      "parent_branch_id": "string",
      "draft_exists": false,
      "draft_created_at": 1,
      "draft_is_behind_tip": false,
      "calls_7d": 0,
      "commits_ahead": 1,
      "commits_behind": 1,
      "merged_into_branch_id": "string"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "page_size": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/branches")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```