> 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 agentes

GET https://api.elevenlabs.io/v1/convai/agents

Retorna uma lista dos seus agentes e metadados.

Reference: https://elevenlabs.io/docs/api-reference/agents/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

### Query parameters

- `page_size` (integer, optional, default: 30) — Quantidade máxima de agentes a retornar. Não pode exceder 100; o padrão é 30.
- `search` (string, optional, nullable) — Pesquise pelo nome dos agentes.
- `archived` (boolean, optional, nullable, default: false) — Filtrar agentes por status de arquivamento
- `show_only_owned_agents` (boolean, optional, default: false, deprecated) — Se definido como true, o endpoint omitirá agentes compartilhados com você por outras pessoas e incluirá apenas os que pertencem a você. Obsoleto: use created_by_user_id.
- `created_by_user_id` (string, optional, nullable) — Filtre agentes pelo ID do usuário criador. Quando definido, retorna apenas os agentes criados por este usuário. Tem precedência sobre show_only_owned_agents. Use '@me' para se referir ao usuário autenticado.
- `tags` (list of string, optional, nullable) — Filtre agentes por tag. Repita o parâmetro para corresponder a qualquer uma de várias tags.
- `sort_direction` (enum, optional) — A direção para ordenar os resultados
  - Allowed values: `asc`, `desc`
- `sort_by` (enum, optional, nullable) — O campo pelo qual ordenar os resultados
  - Allowed values: `name`, `created_at`, `call_count_7d`
- `cursor` (string, optional, nullable) — Usado para buscar a próxima página. O cursor é retornado na resposta.

## Response

### 200

Resposta bem-sucedida

- `agents` (list of AgentSummaryResponseModel, required) — Uma lista de agentes e seus metadados.
- `has_more` (boolean, required) — Indica se há mais agentes para paginar
- `next_cursor` (string, optional, nullable) — O próximo cursor para paginar os agentes

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### AgentSummaryResponseModel

- `agent_id` (string, required) — O ID do agente
- `name` (string, required) — O nome do agente
- `voice_id` (string, required) — ID de voz atribuído a este agente
- `tags` (list of string, required) — Tags do agente usadas para categorizá-lo
- `created_at_unix_secs` (integer, required) — O horário de criação do agente em segundos Unix
- `access_info` (ResourceAccessInfo, required) — As informações de acesso do agente
- `last_call_time_unix_secs` (integer, optional, nullable) — O horário da chamada mais recente em segundos Unix; null caso nenhuma chamada tenha sido feita
- `archived` (boolean, optional, default: false) — Se o agente está arquivado.

### 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
{
  "agents": [
    {
      "agent_id": "J3Pbu5gP6NNKBscdCdwB",
      "name": "My Agent",
      "voice_id": "UCaNsl8F6Xh4GALkVMLS",
      "tags": [
        "Customer Support",
        "Technical Help",
        "Eleven"
      ],
      "created_at_unix_secs": 1716153600,
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john@example.com",
        "role": "admin"
      },
      "archived": false
    }
  ],
  "has_more": false,
  "next_cursor": "123"
}
```

**SDK Code**

```python
import requests

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

querystring = {"archived":"false","tags":"[\"Customer Support\"]"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/agents?archived=false&tags=%5B%22Customer+Support%22%5D';
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?archived=false&tags=%5B%22Customer+Support%22%5D"

	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?archived=false&tags=%5B%22Customer+Support%22%5D")

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?archived=false&tags=%5B%22Customer+Support%22%5D")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/agents?archived=false&tags=%5B%22Customer+Support%22%5D');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents?archived=false&tags=%5B%22Customer+Support%22%5D");
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?archived=false&tags=%5B%22Customer+Support%22%5D")! 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()
```