> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.lumenia.net/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.lumenia.net/_mcp/server.

# Get voice integration options

GET https://app.lumenia.net/api/v1/integrations/voice/options

Return supported voice and transcriber options.

Reference: https://docs.lumenia.net/api-reference/workspace-voice/get-voice-integration-options

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <API_KEY>`, where `API_KEY` is your API key.

## Response

### 200

Supported options grouped by provider.

- `options` (V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptions, required) — The catalog. Each provider entry lists the fields it needs plus the allowed values for them.

## Errors

### 403 Forbidden Error

The API key is missing or invalid.

- `message` (string, optional)

### 500 Internal Server Error

Internal Server Error

- `any`

## Types

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptions

The catalog. Each provider entry lists the fields it needs plus the allowed values for them.

- `voice` (V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoice, optional) — Text-to-speech (voice) configuration options.
- `transcriber` (V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriber, optional) — Speech-to-text (transcriber) configuration options.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoice

Text-to-speech (voice) configuration options.

- `providers` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItems, optional) — One entry per supported voice provider.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriber

Speech-to-text (transcriber) configuration options.

- `providers` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItems, optional) — One entry per supported transcriber provider.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItems

- `value` (string, optional) — The value to send as voice.provider.
- `label` (string, optional) — Human-readable provider name.
- `fields` (list of string, optional) — The voice fields this provider needs.
- `voiceIdSource` (string, optional) — Where voiceId values come from: enum (pick from the voiceIds list) or freeform (paste an external id).
- `voiceIdHelp` (string, optional) — Where to find a voiceId, present when voiceIdSource is freeform.
- `notes` (string, optional) — How to fill this provider fields.
- `voiceIds` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItemsVoiceIdsItems, optional) — The allowed voiceId values, present when voiceIdSource is enum. Send the value field.
- `models` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItemsModelsItems, optional) — The allowed model values for this provider, when it takes a model. Send the value field.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItems

- `value` (string, optional) — The value to send as transcriber.provider.
- `label` (string, optional) — Human-readable provider name.
- `fields` (list of string, optional) — The transcriber fields this provider needs.
- `notes` (string, optional) — How to fill this provider fields.
- `models` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItemsModelsItems, optional) — The allowed transcriber models. Each model lists the languages it supports.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItemsVoiceIdsItems

- `value` (string, optional) — The value to send as voice.voiceId.
- `label` (string, optional) — Human-readable voice name.
- `description` (string, optional) — What the voice sounds like.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsVoiceProvidersItemsModelsItems

- `value` (string, optional) — The value to send as voice.model.
- `label` (string, optional) — Human-readable model name.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItemsModelsItems

- `value` (string, optional) — The value to send as transcriber.model.
- `label` (string, optional) — Human-readable model name.
- `languages` (list of V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItemsModelsItemsLanguagesItems, optional) — The languages this model supports. Send the value field as transcriber.language.

### V1IntegrationsVoiceOptionsGetResponsesContentApplicationJsonSchemaOptionsTranscriberProvidersItemsModelsItemsLanguagesItems

- `value` (string, optional) — The value to send as transcriber.language.
- `label` (string, optional) — Human-readable language name.

## Examples

**Response**

```json
{
  "options": {
    "voice": {
      "providers": [
        {
          "value": "vapi",
          "label": "Vapi",
          "fields": [
            "provider",
            "voiceId"
          ],
          "voiceIdSource": "enum",
          "notes": "Pick a voiceId from the `voiceIds` list below and send its `value` (e.g. `voiceIds[0].value`). Set `model` to null or omit the `model` field for this provider.",
          "voiceIds": [
            {
              "value": "Clara",
              "label": "Clara · American · female",
              "description": "Ultra Realistic, Conversational, Friendly"
            }
          ]
        },
        {
          "value": "11labs",
          "label": "11labs",
          "fields": [
            "provider",
            "voiceId",
            "model"
          ],
          "voiceIdSource": "freeform",
          "voiceIdHelp": "Paste a voiceId from https://elevenlabs.io/voice-library",
          "notes": "Send the ElevenLabs voiceId as `voiceId` and pick a model from the `models` list below, sending its `value` (e.g. `models[0].value`).",
          "models": [
            {
              "value": "eleven_multilingual_v2",
              "label": "eleven_multilingual_v2"
            }
          ]
        }
      ]
    },
    "transcriber": {
      "providers": [
        {
          "value": "deepgram",
          "label": "Deepgram",
          "fields": [
            "provider",
            "model",
            "language"
          ],
          "notes": "Pick a model from `models` below and send its `value`, then pick a language from that model's `languages` list and send its `value`.",
          "models": [
            {
              "value": "nova-3",
              "label": "Nova 3",
              "languages": [
                {
                  "value": "en",
                  "label": "English"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.lumenia.net/api/v1/integrations/voice/options"

headers = {"Authorization": "Bearer <API_KEY>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.lumenia.net/api/v1/integrations/voice/options';
const options = {method: 'GET', headers: {Authorization: 'Bearer <API_KEY>'}};

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://app.lumenia.net/api/v1/integrations/voice/options"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <API_KEY>")

	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://app.lumenia.net/api/v1/integrations/voice/options")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <API_KEY>'

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://app.lumenia.net/api/v1/integrations/voice/options")
  .header("Authorization", "Bearer <API_KEY>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.lumenia.net/api/v1/integrations/voice/options', [
  'headers' => [
    'Authorization' => 'Bearer <API_KEY>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://app.lumenia.net/api/v1/integrations/voice/options");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <API_KEY>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <API_KEY>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.lumenia.net/api/v1/integrations/voice/options")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```