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

# Execute agent voice (text-to-speech)

POST https://api.runtype.com/v1/agents/{id}/voice
Content-Type: application/json

Generate speech audio for the given text using the agent voice configuration (ElevenLabs TTS).

Reference: https://docs.runtype.com/api-reference/runtype-api/agents/execute-agent-voice-text-to-speech

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects a map from string to any.

- `map from string to any`

## Response

### 200

Generated audio result

- `success` (boolean, required)
- `audioBase64` (string, optional)
- `audioUrl` (string, optional)
- `duration` (double, optional)
- `modelId` (string, optional)
- `voiceId` (string, optional)

## Errors

### 400 Bad Request Error

Invalid agent ID or missing text parameter

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions or agent does not support voice

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Agent not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

## Examples

**Request**

```json
{
  "modelId": "eleven_v4",
  "text": "Hello, how can I help you today?",
  "voiceId": "rachel"
}
```

**Response**

```json
{
  "success": true,
  "audioBase64": "string",
  "audioUrl": "string",
  "duration": 1.1,
  "modelId": "string",
  "voiceId": "string"
}
```

**SDK Code**

```python Voice Input
import requests

url = "https://api.runtype.com/v1/agents/id/voice"

payload = {
    "modelId": "eleven_v4",
    "text": "Hello, how can I help you today?",
    "voiceId": "rachel"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Voice Input
const url = 'https://api.runtype.com/v1/agents/id/voice';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"modelId":"eleven_v4","text":"Hello, how can I help you today?","voiceId":"rachel"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Voice Input
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/agents/id/voice"

	payload := strings.NewReader("{\n  \"modelId\": \"eleven_v4\",\n  \"text\": \"Hello, how can I help you today?\",\n  \"voiceId\": \"rachel\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Voice Input
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/agents/id/voice")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"modelId\": \"eleven_v4\",\n  \"text\": \"Hello, how can I help you today?\",\n  \"voiceId\": \"rachel\"\n}"

response = http.request(request)
puts response.read_body
```

```java Voice Input
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/agents/id/voice")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"modelId\": \"eleven_v4\",\n  \"text\": \"Hello, how can I help you today?\",\n  \"voiceId\": \"rachel\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/agents/id/voice', [
  'body' => '{
  "modelId": "eleven_v4",
  "text": "Hello, how can I help you today?",
  "voiceId": "rachel"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Voice Input
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/agents/id/voice");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"modelId\": \"eleven_v4\",\n  \"text\": \"Hello, how can I help you today?\",\n  \"voiceId\": \"rachel\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Voice Input
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "modelId": "eleven_v4",
  "text": "Hello, how can I help you today?",
  "voiceId": "rachel"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/agents/id/voice")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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