Speechify Text-to-Speech API

https://docs.sws.speechify.com/
Admin
Speechify's Text-to-Speech API provides cutting-edge TTS capabilities powered by a proprietary AI...
Tokens:204,251
Snippets:1,372
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### List Agent Knowledge Bases (HTTP GET - PHP)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-agent-knowledge-bases

This PHP example uses GuzzleHttp to send a GET request to the API for listing agent knowledge bases. Ensure the GuzzleHttp library is installed.

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.speechify.ai/v1/agents/id/knowledge-bases', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

```

--------------------------------

### List Agent Knowledge Bases (HTTP GET - Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-agent-knowledge-bases

This Ruby example demonstrates how to perform an HTTP GET request to list agent knowledge bases, including setting necessary headers.

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

url = URI("https://api.speechify.ai/v1/agents/id/knowledge-bases")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### List Test Runs via HTTP GET Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

This Swift example demonstrates making an HTTP GET request to list test runs using URLSession. It includes setting up headers and handling the response.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tests/id/runs")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### List Agent Knowledge Bases (HTTP GET - Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-agent-knowledge-bases

This Swift example shows how to construct and send an HTTP GET request using URLSession to retrieve agent knowledge bases. It includes setting headers and handling the response.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/agents/id/knowledge-bases")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### List Agent Tools using HTTP Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/Swift)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

### Request Example
```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/agents/id/tools")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
```
```

--------------------------------

### List Agent Tools using HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/Go)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

### Request Example
```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/agents/id/tools"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}
```
```

--------------------------------

### Download Sample using HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/voices/download-sample

Make a direct HTTP GET request to download a voice sample. This example demonstrates setting the Authorization header.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/voices/id/sample"

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

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

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

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

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

}

```

--------------------------------

### Get Test Run via HTTP Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test-run

Make an HTTP GET request in Swift to retrieve a test run. This example uses URLSession and NSMutableURLRequest to set up the request.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/test-runs/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### List Agent Tools using HTTP Request (PHP)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/PHP)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.speechify.ai/v1/agents/id/tools', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

--------------------------------

### List Agent Tools using HTTP Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/C#)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

### Request Example
```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/agents/id/tools");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```
```

--------------------------------

### List Agent Tools via HTTP GET Request (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example using Unirest library in Java to perform an HTTP GET request for listing agent tools. Includes setting authorization and content-type headers.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/agents/id/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Get Test Run via HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test-run

Make a direct HTTP GET request to the Speechify API to retrieve a test run. This example demonstrates setting headers and handling the response.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/test-runs/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### List Agent Tools using HTTP Request (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/Java)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

### Request Example
```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/agents/id/tools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```
```

--------------------------------

### List Agent Tools using HTTP Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using a direct HTTP GET request.

```APIDOC
## List Agent Tools (HTTP/Ruby)

### Description
Retrieves a list of tools for a specific agent via an HTTP GET request.

### Method
GET

### Endpoint
`/v1/agents/{agentId}/tools`

### Parameters
#### Path Parameters
- **agentId** (string) - Required - The ID of the agent.

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.
- **Content-Type** (string) - Required - `application/json`

### Request Example
```ruby
require 'uri'
require 'net/http'

url = URI("https://api.speechify.ai/v1/agents/id/tools")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

--------------------------------

### List Agent Tools via HTTP GET Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example using RestSharp in C# to execute a GET request for listing agent tools. Shows how to add headers and request body parameters.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/agents/id/tools");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### List Test Runs via HTTP GET Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

This Ruby example shows how to perform an HTTP GET request to list test runs, including setting the necessary authorization and content-type headers.

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

url = URI("https://api.speechify.ai/v1/tests/id/runs")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### List Test Runs via HTTP GET Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

Make a direct HTTP GET request to the Speechify API to list test runs. This example uses Go and includes setting authorization headers and content type.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/tests/id/runs"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### Download Sample using Unirest (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/voices/download-sample

This Java example uses the Unirest library to make a GET request for downloading a voice sample, setting the Authorization header.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/voices/id/sample")
  .header("Authorization", "Bearer <token>")
  .asString();

```

--------------------------------

### Download Sample using RestSharp (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/voices/download-sample

This C# example uses RestSharp to send a GET request for downloading a voice sample. It shows how to configure the client and add the Authorization header.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/voices/id/sample");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);

```

--------------------------------

### List TTS Tools via HTTP Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/tools/list

This Ruby example demonstrates how to fetch TTS tools by making an HTTP GET request to the Speechify API.

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

url = URI("https://api.speechify.ai/v1/tools")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### Download Sample using URLSession (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/voices/download-sample

This Swift example uses URLSession to make a GET request to download a voice sample. It demonstrates setting up the request with headers and resuming the data task.

```swift
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/voices/id/sample")! 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()

```

--------------------------------

### List Test Runs via HTTP GET Request (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

An example in Java using the Unirest library to make an HTTP GET request to list test runs. Ensure the Unirest library is included in your project.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/tests/id/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### List All Tests via HTTP Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-all-tests

This Ruby example shows how to fetch all tests by making a GET request to the Speechify API.

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

url = URI("https://api.speechify.ai/v1/tests")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### List Test Attachments using HTTP Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-attachments

Implement a GET request in Swift using URLSession to fetch test attachments. This example covers setting up headers and the request.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tests/id/attachments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### List All Tests via HTTP Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-all-tests

This Swift example demonstrates making a GET request to the Speechify API to retrieve a list of all tests.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tests")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### List Test Folders using HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-folders

Make a GET request to the Speechify API endpoint for listing test folders. This example demonstrates direct HTTP interaction.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/test-folders"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### List Agent Tests using HTTP Request in Swift

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tests

This Swift example shows how to construct and execute an HTTP GET request using URLSession to fetch agent tests from the Speechify API.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/agents/id/tests")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### Attach Knowledge Base using Go HTTP Client

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/attach-knowledge-base

This example demonstrates attaching a knowledge base via a direct HTTP POST request in Go. Remember to replace '<token>' with your actual authorization token.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/agents/id/knowledge-bases/kbId"

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

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

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

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

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

}

```

--------------------------------

### List Agent Tools via HTTP GET Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Demonstrates making an HTTP GET request in Swift to retrieve agent tools. Includes setting up URL, headers, and handling the response.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/agents/id/tools")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### Get Dynamic Variables with PHP Guzzle

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-dynamic-variables

This example demonstrates fetching dynamic variables using the Guzzle HTTP client in PHP. Ensure Guzzle is installed via Composer.

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.speechify.ai/v1/agents/id/variables', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

```

--------------------------------

### Get Dynamic Variables with Swift URLSession

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-dynamic-variables

This Swift example uses URLSession to make a GET request to the Speechify API. It includes setting up headers and handling the response.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/agents/id/variables")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### Get TTS Agent by ID using HTTP GET (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get

An example in C# using the RestSharp library to make an HTTP GET request to the Speechify TTS Agents API. It covers configuring the client, request, headers, and body.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/agents/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Get TTS Agent by ID using HTTP GET (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get

A Java example demonstrating how to make an HTTP GET request to the Speechify TTS Agents API using the Unirest library. It shows how to set headers and send the request.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/agents/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Get TTS Agent by ID using HTTP GET (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get

Provides a Ruby example for directly calling the Speechify TTS Agents API via an HTTP GET request. It includes setting up the URI, headers, and processing the response.

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

url = URI("https://api.speechify.ai/v1/agents/id")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### Get TTS Agent by ID using HTTP GET (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get

Illustrates making a direct HTTP GET request to the Speechify TTS Agents API using Go. This example shows how to set up the request, headers, and handle the response.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/agents/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### List Conversations via HTTP GET Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/conversations/list

Example of listing conversations using C# and the RestSharp library. This involves creating a GET request with appropriate headers and body.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/conversations");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Create Test Folder using HTTP Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/create-test-folder

This Ruby example shows how to create a test folder by sending an HTTP POST request. Replace '<token>' with your valid API token.

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

url = URI("https://api.speechify.ai/v1/test-folders")

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  \"name\": \"QA Automation Tests\"\n}"

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

```

--------------------------------

### Create Test Folder using HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/create-test-folder

This example demonstrates how to create a test folder by making a direct HTTP POST request to the Speechify API. Remember to replace '<token>' with your actual API token.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/test-folders"

	payload := strings.NewReader("{\n  \"name\": \"QA Automation Tests\"\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))

}

```

--------------------------------

### List Conversations via HTTP GET Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/conversations/list

This Ruby example shows how to fetch conversations using an HTTP GET request. It includes setting the Authorization and Content-Type headers.

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

url = URI("https://api.speechify.ai/v1/conversations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### Get TTS Tool by ID using Java Unirest

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/tools/get

An example in Java using the Unirest library to make a GET request for a TTS tool. It shows how to add headers and the request body.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/tools/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Create Conversation using Go HTTP Client

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/create-conversation

This Go example shows how to make a direct HTTP POST request to create a conversation. It includes setting the Authorization and Content-Type headers.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/agents/id/conversations"

	payload := strings.NewReader("{}")

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

}

```

--------------------------------

### Basic SSML Usage

Source: https://docs.sws.speechify.com/text-to-speech/features/ssml

A simple SSML example demonstrating the basic structure with a speak tag.

```xml
<speak>Welcome to Speechify's Text-to-Speech service.</speak>
```

--------------------------------

### Get Test Stats using HTTP Request (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test-stats

This Java example uses the Unirest library to make an HTTP GET request for test statistics. Configure the Authorization and Content-Type headers.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/tests/stats")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Get TTS Tool by ID using Swift URLSession

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/tools/get

This Swift example uses URLSession to make a GET request to the Speechify API for a TTS tool. It covers setting up headers and the request body.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tools/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### Install Python SDK

Source: https://docs.sws.speechify.com/api-reference/api-reference/introduction

Install the official Speechify API SDK for Python using pip.

```bash
pip install speechify-api
```

--------------------------------

### Get Test Agent using HTTP Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test

A C# example using RestSharp to perform a GET request to the Speechify API. This code illustrates setting the request method, headers, and body.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/tests/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Get Test Run with Speechify Library (Python)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test-run

Fetch a test run using the Speechify Python library. Initialize the client with your token before making the request.

```python
from speechify import Speechify

client = Speechify(
    token="YOUR_TOKEN_HERE",
)

client.tts.agents.get_test_run(
    id="id",
)

```

--------------------------------

### Get Test Stats using HTTP Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test-stats

This C# example utilizes the RestSharp library to perform an HTTP GET request for test statistics. It demonstrates setting the Authorization and Content-Type headers.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/tests/stats");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Create Knowledge Base - Python

Source: https://docs.sws.speechify.com/voice-agents/build/knowledge-base

Use this to create a new knowledge base. Provide a name and description for the knowledge base.

```python
from speechify import Speechify

client = Speechify()

kb = client.tts.knowledge_bases.create(
    name="Product Handbook",
    description="Manuals, FAQs, troubleshooting",
)
print(kb.id)
```

--------------------------------

### Attach Tool using Go HTTP Request

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/attach-tool

Demonstrates making a direct HTTP POST request to attach a tool to an agent using Go. Includes setting the Authorization header.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/agents/id/tools/toolId"

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

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

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

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

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

}

```

--------------------------------

### Get Test Agent using HTTP Request (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test

This Swift example shows how to construct and send an HTTP GET request to the Speechify API using URLSession. It covers setting headers and handling the response.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tests/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()

```

--------------------------------

### Update Test Folder with Go HTTP Client

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/update-test-folder

This example demonstrates how to update a test folder using Go's standard HTTP client. Remember to replace '<token>' with your actual API token.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/test-folders/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", 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))

}

```

--------------------------------

### Get Test Agent using HTTP Request (Go)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test

Make a direct HTTP GET request to the Speechify API endpoint to retrieve a test agent. This example shows how to set headers and handle the response.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/tests/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### Get TTS Tool by ID using Go HTTP Client

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/tools/get

Make a direct HTTP GET request to the Speechify API to retrieve a TTS tool. This example uses Go's standard net/http package.

```go
package main

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

func main() {

	url := "https://api.speechify.ai/v1/tools/id"


payload := strings.NewReader("{}")


	req, _ := http.NewRequest("GET", 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))

}

```

--------------------------------

### List Agent Tools using Speechify SDK (Python)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-tools

Example of how to list tools for an agent using the Speechify Python SDK.

```APIDOC
## List Agent Tools (Python)

### Description
Lists the tools available for a specific agent.

### Method
`client.tts.agents.list_tools(id: str)`

### Parameters
#### Path Parameters
- **id** (str) - Required - The ID of the agent whose tools you want to list.

### Request Example
```python
from speechify import Speechify

client = Speechify(
    token="YOUR_TOKEN_HERE",
)

client.tts.agents.list_tools(
    id="id",
)
```
```

--------------------------------

### List Test Runs via HTTP GET Request (C#)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

Example in C# using the RestSharp library to perform an HTTP GET request for listing test runs. Configure the client and request with appropriate headers.

```csharp
using RestSharp;

var client = new RestClient("https://api.speechify.ai/v1/tests/id/runs");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

```

--------------------------------

### Create TTS Tool via HTTP POST (Swift)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/tools/create

This Swift example demonstrates creating a TTS tool by making an HTTP POST request. It includes setting up headers and the JSON body for the request.

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "End Call Tool",
  "description": "Terminates the current call session immediately.",
  "kind": "system"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.speechify.ai/v1/tools")! 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()

```

--------------------------------

### Get Test Agent using HTTP Request (Java)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test

An example in Java using the Unirest library to make a GET request to the Speechify API for test agent data. Ensure the Unirest library is included in your project.

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

HttpResponse<String> response = Unirest.get("https://api.speechify.ai/v1/tests/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

```

--------------------------------

### Create Test Folder using PHP Guzzle Client

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/create-test-folder

This PHP example utilizes the Guzzle HTTP client to create a test folder. Make sure to include the Guzzle HTTP client in your project's dependencies.

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.speechify.ai/v1/test-folders', [
  'body' => '{ 
  "name": "QA Automation Tests"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

```

--------------------------------

### Get Test Agent using HTTP Request (Ruby)

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/get-test

This Ruby example demonstrates making an HTTP GET request to the Speechify API to fetch test agent details. It includes setting authorization and content-type headers.

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

url = URI("https://api.speechify.ai/v1/tests/id")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

```

--------------------------------

### List Test Runs with Python SDK

Source: https://docs.sws.speechify.com/api-reference/api-reference/tts/agents/list-test-runs

This Python example demonstrates how to use the Speechify library to list test runs. Replace 'YOUR_TOKEN_HERE' with your actual token.

```python
from speechify import Speechify

client = Speechify(
    token="YOUR_TOKEN_HERE",
)

client.tts.agents.list_test_runs(
    id="id",
)


```

--------------------------------

### Create BYOC SIP Trunk (Telnyx Example)

Source: https://docs.sws.speechify.com/voice-agents/build/phone-numbers

This command creates a SIP trunk for a Bring Your Own Carrier (BYOC) provider, using Telnyx as an example. Configure `allowed_addresses` to restrict incoming calls or leave empty for initial setup.

```bash
curl -X POST https://api.speechify.ai/v1/sip-trunks \
  -H "Authorization: Bearer $SPEECHIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Telnyx BYOC",
    "kind": "byoc",
    "direction": "both",
    "sip_address": "sip.telnyx.com",
    "auth_username": "your_telnyx_sip_user",
    "auth_password": "your_telnyx_sip_password",
    "allowed_addresses": ["216.32.234.0/24"],
    "transport": "udp",
    "media_encryption": "allow"
  }'
```
Tokens:
Raw