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

# Conversaties weergeven

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

Haal alle gesprekken op van agents waarvan de gebruiker eigenaar is. Met de optie om te beperken tot een specifieke agent.

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

- `cursor` (string, optional, nullable) — Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.
- `agent_id` (string, optional, nullable) — Agent-ID (agent_…) of externe ID van de spraakengine (seng_), die naar dezelfde onderliggende resource verwijzen.
- `visited_agent_ids` (list of string, optional, nullable) — Filter gesprekken waaraan een van deze agents heeft deelgenomen. Maximaal 50 waarden.
- `visited_agent_branch_ids` (list of string, optional, nullable) — Filter gesprekken waaraan een van deze agentbranches heeft deelgenomen. Maximaal 50 waarden.
- `triggered_procedure_ids` (list of string, optional, nullable) — Filter gesprekken waarin een van deze procedures is geactiveerd. Maximaal 50 waarden.
- `call_successful` (enum, optional, nullable) — Het resultaat van de succesevaluatie
  - Allowed values: `success`, `failure`, `unknown`, `error`
- `call_start_before_unix` (integer, optional, nullable) — Unix-timestamp (in seconden) om gesprekken tot deze startdatum te filteren.
- `call_start_after_unix` (integer, optional, nullable) — Unix-timestamp (in seconden) om gesprekken vanaf deze startdatum te filteren.
- `call_duration_min_secs` (integer, optional, nullable) — Minimale gespreksduur in seconden.
- `call_duration_max_secs` (integer, optional, nullable) — Maximale gespreksduur in seconden.
- `rating_max` (integer, optional, nullable) — Maximale algemene beoordeling (1-5).
- `rating_min` (integer, optional, nullable) — Minimale algemene beoordeling (1-5).
- `has_feedback_comment` (boolean, optional, nullable) — Filter gesprekken met feedbackreacties van gebruikers.
- `user_id` (string, optional, nullable) — Filter gesprekken op de gebruikers-ID van degene die ze heeft gestart.
- `evaluation_params` (list of string, optional, nullable) — Evaluatiefilters. Herhaalbare parameter. Indeling: criteria_id:result, waarbij result een van success|failure|unknown is. Voorbeeld: eval=value_framing:success
- `data_collection_params` (list of string, optional, nullable) — Filters voor gegevensverzameling. Herhaalparameter. Indeling: id:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Gebruik voor in een pipe als scheidingsteken tussen waarden. Een lege waarde komt overeen met gesprekken waarin het veld niet is verzameld (id:eq:), en neq met een lege waarde komt overeen met gesprekken waarin dat wel het geval was (id:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde.
- `dynamic_variable_params` (list of string, optional, nullable) — Filters voor dynamische variabelen. Herhaalbare parameter. Indeling: name:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Scheid waarden voor in met een verticale streep. Een lege waarde komt overeen met gesprekken waarin de variabele niet was ingesteld (name:eq:), en neq met een lege waarde komt overeen met gesprekken waarin deze wel was ingesteld (name:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde. Namen die ':' bevatten, kunnen niet worden uitgedrukt.
- `data_collection_ids` (list of string, optional, nullable) — ID's van gegevensverzamelingsvelden die in elke gesprekssamenvatting moeten worden opgenomen. Herhaalparameter. Als deze wordt weggelaten, wordt data_collection_results niet geretourneerd.
- `evaluation_criteria_ids` (list of string, optional, nullable) — ID's van evaluatiecriteria die in elke gesprekssamenvatting moeten worden opgenomen. Herhaalbare parameter. Indien weggelaten, wordt evaluation_criteria_results niet teruggestuurd.
- `tool_names` (list of string, optional, nullable) — Filter gesprekken op toolnamen die tijdens de call zijn gebruikt.
- `tool_names_successful` (list of string, optional, nullable) — Filter gesprekken op toolnamen met geslaagde calls.
- `tool_names_errored` (list of string, optional, nullable) — Filter gesprekken op toolnamen met mislukte calls.
- `include_invalid_tool_calls` (boolean, optional, default: false) — Komt ook overeen met toolaanroepen die nooit zijn uitgevoerd.
- `main_languages` (list of string, optional, nullable) — Filter gesprekken op gedetecteerde hoofdtaal (taalcode).
- `page_size` (integer, optional, default: 30) — Het maximale aantal gesprekken dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.
- `summary_mode` (enum, optional, default: exclude) — Of transcript-samenvattingen in de response moeten worden opgenomen.
  - Allowed values: `exclude`, `include`
- `search` (string, optional, nullable, deprecated) — Volledige-tekst- of fuzzyzoekopdracht in transcriptberichten
- `conversation_initiation_source` (enum, optional, nullable, default: unknown) — Enum die de mogelijke bronnen voor het starten van een gesprek weergeeft.
  - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool`
- `text_only` (boolean, optional, nullable)
- `conversation_product_type` (enum, optional, nullable) — Beperk de resultaten tot één productinterface voor gesprekken.
  - Allowed values: `agents`, `speech_engine`
- `branch_id` (string, optional, nullable) — Filter gesprekken op branch-ID.
- `version_id` (string, optional, nullable) — Filter gesprekken op versie-ID.
- `parent_conversation_id` (string, optional, nullable) — Filter gesprekken op bovenliggende gespreks-ID voor subagentgesprekken.
- `topic_ids` (list of string, optional, nullable) — Filter gesprekken op topic-ID's die tijdens topic discovery zijn toegewezen.
- `exclude_statuses` (list of enum, optional, nullable) — Sluit gesprekken met de opgegeven statussen uit. Handig om gesprekken die nog bezig zijn / worden verwerkt te verbergen in lijstweergaven.
  - Allowed values: `initiated`, `in-progress`, `processing`, `done`, `failed`
- `tag_ids` (list of string, optional, nullable) — Filter gesprekken op gespreks-tag-ID's die zijn toegewezen via de conversation-tags-endpoints.
- `workflow_node_entered_id` (string, optional, nullable) — Filter alleen op gesprekken die het opgegeven knooppunt hebben bereikt.
- `termination_reasons` (list of string, optional, nullable) — Filter gesprekken op hun opgeslagen termination_reason (metadata.termination_reason). Herhaal de parameter om een van meerdere waarden te matchen.
- `guardrail_types` (list of enum, optional, nullable) — Filter op gesprekken waarin een guardrail van een van deze typen is geactiveerd (metadata.triggered_guardrails.guardrail_type). Herhaal de parameter om een van meerdere waarden te matchen.
  - Allowed values: `custom`, `prompt_injection`, `self_harm_intent`, `violence_graphic`, `sexual`, `violence`, `harassment`, `sexual_minors`, `self_harm`, `self_harm_instructions`, `harassment_threatening`, `hate`, `hate_threatening`, `profanity`, `religion_or_politics`, `medical_and_legal`, `guardrail`
- `custom_guardrail_names` (list of string, optional, nullable) — Filter op gesprekken waarin een aangepaste guardrail met een van deze namen is geactiveerd (metadata.triggered_guardrails.guardrail_name). Alleen aangepaste guardrails hebben een naam. Herhaal de parameter om een van meerdere waarden te matchen.
- `sort_direction` (enum, optional) — De richting om gesprekken te sorteren op starttijd van het gesprek. Standaard aflopend (nieuwste eerst).
  - Allowed values: `asc`, `desc`

## Response

### 200

Geslaagde response

- `conversations` (list of ConversationSummaryResponseModel, required)
- `has_more` (boolean, required)
- `next_cursor` (string, optional, nullable)

## Errors

### 422 Unprocessable Entity Error

Validatiefout

- `detail` (list of ValidationError, optional)

## Types

### ConversationSummaryResponseModel

- `agent_id` (string, required)
- `conversation_id` (string, required)
- `start_time_unix_secs` (integer, required)
- `call_duration_secs` (integer, required)
- `message_count` (integer, required)
- `status` (enum, required)
  - Allowed values: `initiated`, `in-progress`, `processing`, `done`, `failed`
- `call_successful` (enum, required)
  - Allowed values: `success`, `failure`, `unknown`
- `branch_id` (string, optional, nullable)
- `version_id` (string, optional, nullable)
- `agent_name` (string, optional, nullable)
- `termination_reason` (string, optional, default: )
- `call_success_score` (double, optional, nullable)
- `transcript_summary` (string, optional, nullable)
- `call_summary_title` (string, optional, nullable)
- `main_language` (string, optional, nullable)
- `conversation_initiation_source` (enum, optional, nullable, default: unknown) — Enum die de mogelijke bronnen voor het starten van een gesprek weergeeft.
  - Allowed values: `unknown`, `android_sdk`, `node_js_sdk`, `react_native_sdk`, `react_sdk`, `js_sdk`, `python_sdk`, `widget`, `sip_trunk`, `twilio`, `exotel`, `genesys`, `avaya`, `audiocodes`, `swift_sdk`, `whatsapp`, `twilio_sms`, `flutter_sdk`, `zendesk_integration`, `slack_integration`, `telegram_integration`, `intercom_integration`, `freshdesk_integration`, `salesforce_integration`, `template_preview`, `genesys_bot_connector`, `subagent_tool`
- `tool_names` (list of string, optional, nullable)
- `direction` (enum, optional, nullable, default: inbound)
  - Allowed values: `inbound`, `outbound`
- `rating` (double, optional, nullable)
- `sentiment_analysis` (ConversationSentimentAnalysis, optional, nullable)
- `data_collection_results` (map from string to any, optional, nullable)
- `evaluation_criteria_results` (map from string to EvaluationCriteriaSummaryResult, optional, nullable)
- `tag_ids` (list of string, optional) — ID's van gesprekstags die aan dit gesprek zijn toegewezen.

### ValidationError

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

### ConversationSentimentAnalysis

- `overall_label` (enum, required)
  - Allowed values: `positive`, `neutral`, `negative`
- `overall_sentiment_score` (double, required)
- `overall_frustration_score` (double, required)
- `min_user_sentiment_score` (double, required)
- `max_user_frustration_score` (double, required)
- `num_scored_user_turns` (integer, required)

### EvaluationCriteriaSummaryResult

- `result` (enum, required)
  - Allowed values: `success`, `failure`, `unknown`
- `score` (integer, optional, nullable)
- `max_score` (integer, optional, nullable)

### ValidationErrorLocItems

## Examples

**Response**

```json
{
  "conversations": [
    {
      "agent_id": "string",
      "conversation_id": "string",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "string",
      "version_id": "string",
      "agent_name": "string",
      "termination_reason": "",
      "call_success_score": 1.1,
      "transcript_summary": "string",
      "call_summary_title": "string",
      "main_language": "string",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "string"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 0,
        "overall_frustration_score": 0.5,
        "min_user_sentiment_score": 0,
        "max_user_frustration_score": 0.5,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {},
      "evaluation_criteria_results": {},
      "tag_ids": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
```

**SDK Code**

```python
import requests

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

querystring = {"agent_id":"agent_3701k3ttaq12ewp8b7qv5rfyszkz","call_successful":"success"}

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

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success';
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/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success"

	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/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success")

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/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success");
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/conversations?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success")! 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()
```