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

# Agents auflisten

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

Gibt eine Liste Ihrer Agenten und ihrer Metadaten zurück.

Reference: https://elevenlabs.io/docs/eleven-agents/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) — Maximale Anzahl zurückzugebender Agenten. Darf 100 nicht überschreiten, Standardwert ist 30.
- `search` (string, optional) — Nach Agentenname suchen.
- `archived` (boolean, optional) — Agenten nach Archivstatus filtern
- `show_only_owned_agents` (boolean, optional, default: false, deprecated) — Wenn auf true gesetzt, lässt der Endpunkt alle Agenten aus, die Ihnen von anderen freigegeben wurden, und enthält nur Ihre eigenen. Veraltet: Verwenden Sie stattdessen created_by_user_id.
- `created_by_user_id` (string, optional) — Agenten nach Benutzer-ID des Erstellers filtern. Wenn festgelegt, werden nur von diesem Nutzer erstellte Agenten zurückgegeben. Hat Vorrang vor show_only_owned_agents. Verwenden Sie '@me' für den authentifizierten Nutzer.
- `tags` (string, optional) — Agenten nach Tag filtern. Wiederholen Sie den Parameter, um mehrere Tags abzugleichen.
- `sort_direction` (enum, optional) — Die Richtung zum Sortieren der Ergebnisse
  - Allowed values: `asc`, `desc`
- `sort_by` (enum, optional) — Das Feld, nach dem die Ergebnisse sortiert werden
  - Allowed values: `name`, `created_at`, `call_count_7d`
- `cursor` (string, optional) — Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

## Response

### 200

Erfolgreiche Antwort

- `agents` (list of AgentSummaryResponseModel, required) — Eine Liste von Agenten und ihren Metadaten
- `has_more` (boolean, required) — Ob weitere Agenten für die Paginierung vorhanden sind.
- `next_cursor` (string, optional) — Der nächste Cursor zum Durchblättern der Agenten

## Errors

### 422 Agents List Request Unprocessable Entity Error

Validierungsfehler

- `detail` (list of ValidationError, optional)

## Types

### AgentSummaryResponseModel

- `agent_id` (string, required) — Die ID des Agenten
- `name` (string, required) — Der Name des Agenten
- `voice_id` (string, required) — Diesem Agenten zugewiesene Stimmen-ID
- `tags` (list of string, required) — Tags zur Kategorisierung des Agenten
- `created_at_unix_secs` (integer, required) — Der Erstellungszeitpunkt des Agenten in Unix-Sekunden
- `access_info` (ResourceAccessInfo, required) — Die Zugriffsinformationen des Agents
- `last_call_time_unix_secs` (integer, optional) — Der Zeitpunkt des letzten Aufrufs in Unix-Sekunden; null, wenn keine Aufrufe erfolgt sind
- `archived` (boolean, optional, default: false) — Gibt an, ob der Agent archiviert ist.

### ValidationError

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

### ResourceAccessInfo

- `is_creator` (boolean, required) — Ob der Nutzer, der die Anfrage stellt, den Agenten erstellt hat.
- `creator_name` (string, required) — Name des Erstellers des Agenten
- `creator_email` (string, required) — E-Mail-Adresse des Erstellers des Agents
- `role` (enum, required) — Die Rolle des Benutzers, der die Anfrage stellt
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `anonymous_access_level_override` (enum, optional) — Die Zugriffsebene für anonyme Nutzer. Bei None ist die Ressource nicht öffentlich freigegeben.
  - Allowed values: `admin`, `editor`, `commenter`, `viewer`
- `access_source` (enum, optional) — Warum der anfragende Nutzer Zugriff auf diese Ressource hat. 'creator' = der Aufrufer ist der Eigentümer. 'explicit' = der Aufrufer (oder eine seiner Workspace-Gruppen) ist zusätzlich zur workspaceweiten Gruppe „everyone“ in role_to_group_ids aufgeführt. 'workspace_default' = die workspaceweite Gruppe „everyone“ ist in role_to_group_ids aufgeführt (jedes nicht anonyme Workspace-Mitglied, einschließlich Administratoren, sieht diese Ressource). 'workspace_admin' = der Aufrufer ist Workspace-Administrator und der Administratorzugang ist der *einzige* Zugriffsweg; reserviert für Dokumente, die sonst niemand sehen kann. Ermöglicht der Benutzeroberfläche offenzulegen, warum ein Betrachter mit Administrator-Bypass ein Dokument sieht, das nicht explizit mit ihm geteilt wurde.
  - Allowed values: `creator`, `explicit`, `workspace_admin`, `workspace_default`

### ValidationErrorLocItem

## 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"
      },
      "last_call_time_unix_secs": 1,
      "archived": false
    }
  ],
  "has_more": false,
  "next_cursor": "123"
}
```

**SDK Code**

```python
import requests

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

querystring = {"archived":"true","created_by_user_id":"created_by_user_id","cursor":"cursor","page_size":"1","search":"search","show_only_owned_agents":"true","sort_by":"name","sort_direction":"asc","tags":"[\"tags\"]"}

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

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/agents?archived=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%22%5D');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents?archived=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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=true&created_by_user_id=created_by_user_id&cursor=cursor&page_size=1&search=search&show_only_owned_agents=true&sort_by=name&sort_direction=asc&tags=%5B%22tags%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()
```