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

# Rechercher du texte dans les messages de conversation

GET https://api.elevenlabs.io/v1/convai/conversations/messages/text-search

Rechercher dans les messages des transcriptions de conversations par recherche en texte intégral et approximative

Reference: https://elevenlabs.io/docs/api-reference/conversations/messages/text-search

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

- `text_query` (string, required) — Le texte de la requête de recherche pour la correspondance plein texte et approximative
- `agent_id` (string, optional, nullable) — Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
- `visited_agent_ids` (list of string, optional, nullable) — Filtrer les conversations auxquelles l'un de ces agents a participé. Ne peut pas dépasser 50 valeurs.
- `visited_agent_branch_ids` (list of string, optional, nullable) — Filtrer les conversations auxquelles l'une de ces branches d'agent a participé. Ne peut pas dépasser 50 valeurs.
- `triggered_procedure_ids` (list of string, optional, nullable) — Filtrer les conversations dans lesquelles l'une de ces procédures a été déclenchée. Ne peut pas dépasser 50 valeurs.
- `call_successful` (enum, optional, nullable) — Le résultat de l'évaluation de réussite
  - Allowed values: `success`, `failure`, `unknown`, `error`
- `call_start_before_unix` (integer, optional, nullable) — Horodatage Unix, en secondes, permettant de filtrer les conversations jusqu’à cette date de début.
- `call_start_after_unix` (integer, optional, nullable) — Horodatage Unix, en secondes, permettant de filtrer les conversations postérieures à cette date de début.
- `call_duration_min_secs` (integer, optional, nullable) — Durée minimale de l’appel en secondes.
- `call_duration_max_secs` (integer, optional, nullable) — Durée maximale de l’appel en secondes.
- `rating_max` (integer, optional, nullable) — Note globale maximale (1 à 5).
- `rating_min` (integer, optional, nullable) — Note globale minimale (1 à 5).
- `has_feedback_comment` (boolean, optional, nullable) — Filtrer les conversations contenant des commentaires d'utilisateurs.
- `user_id` (string, optional, nullable) — Filtrer les conversations par ID de l'utilisateur qui les a initiées.
- `evaluation_params` (list of string, optional, nullable) — Filtres d'évaluation. Paramètre répétable. Format : criteria_id:result, où result est success|failure|unknown. Exemple : eval=value_framing:success
- `data_collection_params` (list of string, optional, nullable) — Filtres de collecte de données. Paramètre répétable. Format : id:op:value, où op est l'une des valeurs eq|neq|gt|gte|lt|lte|in. Pour in, séparez les valeurs par une barre verticale. Une valeur vide correspond aux conversations où le champ n'a pas été collecté (id:eq:), tandis que neq avec une valeur vide correspond à celles où il l'a été (id:neq:). eq indique une égalité exacte. gt|gte|lt|lte requièrent une valeur numérique.
- `dynamic_variable_params` (list of string, optional, nullable) — Filtres de variables dynamiques. Paramètre répétable. Format : name:op:value, où op correspond à eq|neq|gt|gte|lt|lte|in. Pour in, séparez les valeurs par des barres verticales. Une valeur vide correspond aux conversations où la variable n’était pas définie (name:eq:) ; neq avec une valeur vide correspond aux conversations où elle l’était (name:neq:). eq indique une égalité exacte. gt|gte|lt|lte requièrent une valeur numérique. Les noms contenant ':' ne peuvent pas être exprimés.
- `tool_names` (list of string, optional, nullable) — Filtrer les conversations par noms d'outils utilisés pendant l'appel.
- `tool_names_successful` (list of string, optional, nullable) — Filtrer les conversations par noms d'outils ayant généré des appels réussis.
- `tool_names_errored` (list of string, optional, nullable) — Filtrer les conversations par noms d'outils ayant généré des appels en erreur.
- `include_invalid_tool_calls` (boolean, optional, default: false) — Inclut également les appels d'outils qui n'ont jamais été exécutés.
- `main_languages` (list of string, optional, nullable) — Filtrer les conversations par langue principale détectée (code de langue).
- `exclude_statuses` (list of enum, optional, nullable) — Exclut les conversations ayant les statuts indiqués. Utile pour masquer des listes les conversations en cours ou en traitement.
  - Allowed values: `initiated`, `in-progress`, `processing`, `done`, `failed`
- `termination_reasons` (list of string, optional, nullable) — Filtrer les conversations par leur termination_reason enregistrée (metadata.termination_reason). Répétez le paramètre pour correspondre à l'une de plusieurs valeurs.
- `page_size` (integer, optional, default: 20) — Nombre de résultats par page. Maximum : 50.
- `summary_mode` (enum, optional, default: exclude) — Indique s'il faut inclure les résumés de transcriptions dans la réponse.
  - Allowed values: `exclude`, `include`
- `conversation_initiation_source` (enum, optional, nullable, default: unknown) — Énumération représentant les sources possibles d'initiation d'une conversation.
  - 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) — Limite les résultats à une seule interface du produit de conversation.
  - Allowed values: `agents`, `speech_engine`
- `branch_id` (string, optional, nullable) — Filtrer les conversations par ID de branche.
- `version_id` (string, optional, nullable) — Filtrer les conversations par ID de version.
- `topic_ids` (list of string, optional, nullable) — Filtrer les conversations par ID de sujets attribués lors de la découverte de sujets.
- `sort_by` (enum, optional) — Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time.
  - Allowed values: `search_score`, `created_at`
- `cursor` (string, optional, nullable) — Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

## Response

### 200

Réponse réussie

- `results` (list of MessagesSearchResult, required)
- `has_more` (boolean, required) — Indique si d’autres résultats sont disponibles
- `meta` (ListResponseMeta, optional)
- `next_cursor` (string, optional, nullable) — Curseur pour la page suivante de résultats

## Errors

### 422 Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### MessagesSearchResult

transcript_index : index du message dans la transcription de la conversation chunk_text : texte de la transcription ; les messages de transcription très longs peuvent comporter plusieurs segments. chunk_highlights : chunk_text divisé en segments correspondants et non correspondants pour la mise en évidence. Renseigné uniquement pour la recherche par mot-clé ou texte, et non pour la recherche sémantique. score : score de similarité du message avec la requête de recherche

- `conversation_id` (string, required)
- `agent_id` (string, required)
- `transcript_index` (integer, required)
- `chunk_text` (string, required)
- `score` (double, required)
- `conversation_start_time_unix_secs` (integer, required)
- `agent_name` (string, optional, nullable)
- `chunk_highlights` (list of SearchHighlightSegment, optional, nullable)

### 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)

### SearchHighlightSegment

- `value` (string, required)
- `is_hit` (boolean, required)

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "results": [
    {
      "conversation_id": "string",
      "agent_id": "string",
      "transcript_index": 1,
      "chunk_text": "string",
      "score": 1.1,
      "conversation_start_time_unix_secs": 1,
      "agent_name": "string",
      "chunk_highlights": [
        {
          "value": "string",
          "is_hit": true
        }
      ]
    }
  ],
  "has_more": true,
  "meta": {
    "total": 1,
    "page": 1,
    "page_size": 1
  },
  "next_cursor": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/conversations/messages/text-search"

querystring = {"agent_id":"agent_3701k3ttaq12ewp8b7qv5rfyszkz","call_successful":"success","text_query":"refund policy"}

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

print(response.json())
```

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

	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/messages/text-search?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success&text_query=refund+policy")

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/messages/text-search?agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz&call_successful=success&text_query=refund+policy")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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