Create Phone Call
curl --request POST \
--url https://api.fish.audio/v1/agent/phone-calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <unique-key>' \
--data '{
"agent_id": "<agent-id>",
"phone_number_id": "<phone-number-id>",
"to_number": "+14155550123"
}'import requests
url = "https://api.fish.audio/v1/agent/phone-calls"
payload = {
"agent_id": "<string>",
"phone_number_id": "<string>",
"to_number": "<string>",
"dynamic_variables": {},
"overrides": {
"first_message": "<string>",
"first_message_prompt": "<string>",
"system_prompt": "<string>",
"voice_id": "<string>",
"asr": {},
"llm": { "fallback": {
"models": [
{
"custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": "<string>",
"headers": {}
},
"ttft_timeout_ms": 15250,
"total_timeout_ms": 60500,
"parallel": { "kick_in_ms": 1500 }
}
],
"primary": {
"ttft_timeout_ms": 15250,
"total_timeout_ms": 60500
}
} }
},
"metadata": {},
"llm_extra_body": {},
"sip_headers": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '<string>',
phone_number_id: '<string>',
to_number: '<string>',
dynamic_variables: {},
overrides: {
first_message: '<string>',
first_message_prompt: '<string>',
system_prompt: '<string>',
voice_id: '<string>',
asr: {},
llm: {
fallback: {
models: [
{
custom: {base_url: '<string>', model: '<string>', api_key: '<string>', headers: {}},
ttft_timeout_ms: 15250,
total_timeout_ms: 60500,
parallel: {kick_in_ms: 1500}
}
],
primary: {ttft_timeout_ms: 15250, total_timeout_ms: 60500}
}
}
},
metadata: {},
llm_extra_body: {},
sip_headers: {}
})
};
fetch('https://api.fish.audio/v1/agent/phone-calls', 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.fish.audio/v1/agent/phone-calls",
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' => '<string>',
'phone_number_id' => '<string>',
'to_number' => '<string>',
'dynamic_variables' => [
],
'overrides' => [
'first_message' => '<string>',
'first_message_prompt' => '<string>',
'system_prompt' => '<string>',
'voice_id' => '<string>',
'asr' => [
],
'llm' => [
'fallback' => [
'models' => [
[
'custom' => [
'base_url' => '<string>',
'model' => '<string>',
'api_key' => '<string>',
'headers' => [
]
],
'ttft_timeout_ms' => 15250,
'total_timeout_ms' => 60500,
'parallel' => [
'kick_in_ms' => 1500
]
]
],
'primary' => [
'ttft_timeout_ms' => 15250,
'total_timeout_ms' => 60500
]
]
]
],
'metadata' => [
],
'llm_extra_body' => [
],
'sip_headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.fish.audio/v1/agent/phone-calls"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fish.audio/v1/agent/phone-calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/v1/agent/phone-calls")
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 \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"session_id": "<string>",
"status": "queued"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}Phone Calls
Create Phone Call
Place an outbound call from one of your phone numbers; the agent speaks when the callee answers.
POST
/
v1
/
agent
/
phone-calls
Create Phone Call
curl --request POST \
--url https://api.fish.audio/v1/agent/phone-calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <unique-key>' \
--data '{
"agent_id": "<agent-id>",
"phone_number_id": "<phone-number-id>",
"to_number": "+14155550123"
}'import requests
url = "https://api.fish.audio/v1/agent/phone-calls"
payload = {
"agent_id": "<string>",
"phone_number_id": "<string>",
"to_number": "<string>",
"dynamic_variables": {},
"overrides": {
"first_message": "<string>",
"first_message_prompt": "<string>",
"system_prompt": "<string>",
"voice_id": "<string>",
"asr": {},
"llm": { "fallback": {
"models": [
{
"custom": {
"base_url": "<string>",
"model": "<string>",
"api_key": "<string>",
"headers": {}
},
"ttft_timeout_ms": 15250,
"total_timeout_ms": 60500,
"parallel": { "kick_in_ms": 1500 }
}
],
"primary": {
"ttft_timeout_ms": 15250,
"total_timeout_ms": 60500
}
} }
},
"metadata": {},
"llm_extra_body": {},
"sip_headers": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '<string>',
phone_number_id: '<string>',
to_number: '<string>',
dynamic_variables: {},
overrides: {
first_message: '<string>',
first_message_prompt: '<string>',
system_prompt: '<string>',
voice_id: '<string>',
asr: {},
llm: {
fallback: {
models: [
{
custom: {base_url: '<string>', model: '<string>', api_key: '<string>', headers: {}},
ttft_timeout_ms: 15250,
total_timeout_ms: 60500,
parallel: {kick_in_ms: 1500}
}
],
primary: {ttft_timeout_ms: 15250, total_timeout_ms: 60500}
}
}
},
metadata: {},
llm_extra_body: {},
sip_headers: {}
})
};
fetch('https://api.fish.audio/v1/agent/phone-calls', 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.fish.audio/v1/agent/phone-calls",
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' => '<string>',
'phone_number_id' => '<string>',
'to_number' => '<string>',
'dynamic_variables' => [
],
'overrides' => [
'first_message' => '<string>',
'first_message_prompt' => '<string>',
'system_prompt' => '<string>',
'voice_id' => '<string>',
'asr' => [
],
'llm' => [
'fallback' => [
'models' => [
[
'custom' => [
'base_url' => '<string>',
'model' => '<string>',
'api_key' => '<string>',
'headers' => [
]
],
'ttft_timeout_ms' => 15250,
'total_timeout_ms' => 60500,
'parallel' => [
'kick_in_ms' => 1500
]
]
],
'primary' => [
'ttft_timeout_ms' => 15250,
'total_timeout_ms' => 60500
]
]
]
],
'metadata' => [
],
'llm_extra_body' => [
],
'sip_headers' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.fish.audio/v1/agent/phone-calls"
payload := strings.NewReader("{\n \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api.fish.audio/v1/agent/phone-calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/v1/agent/phone-calls")
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 \"agent_id\": \"<string>\",\n \"phone_number_id\": \"<string>\",\n \"to_number\": \"<string>\",\n \"dynamic_variables\": {},\n \"overrides\": {\n \"first_message\": \"<string>\",\n \"first_message_prompt\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"voice_id\": \"<string>\",\n \"asr\": {},\n \"llm\": {\n \"fallback\": {\n \"models\": [\n {\n \"custom\": {\n \"base_url\": \"<string>\",\n \"model\": \"<string>\",\n \"api_key\": \"<string>\",\n \"headers\": {}\n },\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500,\n \"parallel\": {\n \"kick_in_ms\": 1500\n }\n }\n ],\n \"primary\": {\n \"ttft_timeout_ms\": 15250,\n \"total_timeout_ms\": 60500\n }\n }\n }\n },\n \"metadata\": {},\n \"llm_extra_body\": {},\n \"sip_headers\": {}\n}"
response = http.request(request)
puts response.read_body{
"session_id": "<string>",
"status": "queued"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}{
"status": 123,
"message": "<string>",
"reason": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Retry-safe replay key: the same key with the same body returns the call already placed instead of dialing again (24h window).
Body
application/json
POST phone-calls body, shared by the public and console routes.
to_number is deliberately not format-validated here: the contract orders the E.164 check after the agent/published checks, so it runs in the service with a machine-readable reason.
The team-owned number to dial from (twilio provider only).
Destination in E.164, e.g. +14155550123.
Show child attributes
Show child attributes
Wire twin of @fishaudio/agent-protocol SessionOverrides (session.ts).
Every field must be allow-listed in Agent.overrides_allowed; unauthorized fields fail session creation loudly rather than being silently dropped.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Custom SIP headers for this call's INVITE, imported SIP numbers only. Same rules as the number's termination_headers, and merged over them.
Show child attributes
Show child attributes
Was this page helpful?