Skip to main content
POST
/
voice
/
agents
/
run
Run Agent Turn
curl --request POST \
  --url https://api.example.com/voice/agents/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "<string>",
  "text": "<string>",
  "context": {}
}
'
import requests

url = "https://api.example.com/voice/agents/run"

payload = {
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "<string>",
"text": "<string>",
"context": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
conversation_id: '<string>',
text: '<string>',
context: {}
})
};

fetch('https://api.example.com/voice/agents/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/voice/agents/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'conversation_id' => '<string>',
'text' => '<string>',
'context' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.example.com/voice/agents/run"

payload := strings.NewReader("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"conversation_id\": \"<string>\",\n \"text\": \"<string>\",\n \"context\": {}\n}")

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

req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/voice/agents/run")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"conversation_id\": \"<string>\",\n \"text\": \"<string>\",\n \"context\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/voice/agents/run")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"conversation_id\": \"<string>\",\n \"text\": \"<string>\",\n \"context\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "response_text": "<string>",
  "tool_invocations": []
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Body

application/json

Agent run request model.

agent_id
string<uuid>
required
conversation_id
string
required
text
string
required
context
Context · object
required

Response

Successful Response

Agent run response model.

response_text
string
required
tool_invocations
ToolInvocation · object[]