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

# Obtenir les paramètres Convai

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

Récupère les paramètres Convai pour le Workspace

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/workspace/get

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

## Response

### 200

Réponse réussie

- `conversation_initiation_client_data_webhook` (ConversationInitiationClientDataWebhook, optional)
- `webhooks` (ConvAiWebhooks, optional)
- `can_use_mcp_servers` (boolean, optional, default: false) — Indique si le Workspace peut utiliser des serveurs MCP
- `rag_retention_period_days` (integer, optional, default: 10)
- `conversation_embedding_retention_days` (integer, optional) — Nombre de jours de conservation des représentations vectorielles de conversation. None indique d'utiliser la valeur par défaut du système (30 jours).
- `default_livekit_stack` (enum, optional, default: standard)
  - Allowed values: `standard`, `static`

## Errors

### 422 Settings Get Request Unprocessable Entity Error

Erreur de validation

- `detail` (list of ValidationError, optional)

## Types

### ConversationInitiationClientDataWebhook

- `url` (string, required) — L’URL à laquelle envoyer le webhook
- `request_headers` (map from string to ConversationInitiationClientDataWebhookRequestHeadersValue, required) — Les en-têtes à envoyer avec la requête webhook

### ConvAiWebhooks

- `post_call_webhook_id` (string, optional)
- `events` (list of enum, optional) — Liste des types d'événements à envoyer par webhook. Options : transcript, audio, call_initiation_failure, answering_machine_detection, unredacted_transcript, unredacted_audio.
  - Allowed values: `transcript`, `audio`, `call_initiation_failure`, `answering_machine_detection`, `unredacted_transcript`, `unredacted_audio`
- `transcript_format` (enum, optional, default: json) — Format des webhooks de transcription.
  - Allowed values: `json`, `opentelemetry`
- `exclude_transcript` (boolean, optional, default: false) — Lorsque la valeur est true, les webhooks JSON de transcription après appel omettent la transcription tour par tour. L’analyse, les métadonnées et les autres champs de conversation sont toujours envoyés. Ignoré pour le format de transcription OpenTelemetry.
- `send_audio` (boolean, optional, deprecated) — OBSOLÈTE : utilisez plutôt le champ « events ». Indique si les données audio doivent être envoyées avec les webhooks post-appel pour les conversations ConvAI.

### ValidationError

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

### ConversationInitiationClientDataWebhookRequestHeadersValue

- string
- Conv AI Secret Locator: ConvAiSecretLocator

### ValidationErrorLocItem

- string
- integer

### ConvAiSecretLocator

Utilisé pour référencer un secret du stockage de secrets de l’agent.

- `secret_id` (string, required)

## Examples

**Response**

```json
{
  "conversation_initiation_client_data_webhook": {
    "url": "https://example.com/webhook",
    "request_headers": {
      "Content-Type": "application/json"
    }
  },
  "webhooks": {
    "post_call_webhook_id": "post_call_webhook_id",
    "events": [
      "transcript"
    ],
    "transcript_format": "json",
    "exclude_transcript": true,
    "send_audio": true
  },
  "can_use_mcp_servers": true,
  "rag_retention_period_days": 1,
  "conversation_embedding_retention_days": 1,
  "default_livekit_stack": "standard"
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/settings';
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/settings"

	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/settings")

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/settings")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/settings");
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/settings")! 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()
```