curl --request POST \
--url https://api.pipecat.daily.co/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"serviceName": "voice-starter",
"image": "your-dockername/voice-starter:0.1",
"region": "us-west",
"architecture": "arm64",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"krispViva": {
"audioFilter": "tel"
},
"agentProfile": "agent-1x",
"maxSessionDuration": 3600
}
'import requests
url = "https://api.pipecat.daily.co/v1/agents"
payload = {
"serviceName": "voice-starter",
"image": "your-dockername/voice-starter:0.1",
"region": "us-west",
"architecture": "arm64",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"krispViva": { "audioFilter": "tel" },
"agentProfile": "agent-1x",
"maxSessionDuration": 3600
}
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({
serviceName: 'voice-starter',
image: 'your-dockername/voice-starter:0.1',
region: 'us-west',
architecture: 'arm64',
imagePullSecretSet: 'dockerhub-credentials',
secretSet: 'voice-starter-secrets',
autoScaling: {minAgents: 1, maxAgents: 20},
krispViva: {audioFilter: 'tel'},
agentProfile: 'agent-1x',
maxSessionDuration: 3600
})
};
fetch('https://api.pipecat.daily.co/v1/agents', 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.pipecat.daily.co/v1/agents",
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([
'serviceName' => 'voice-starter',
'image' => 'your-dockername/voice-starter:0.1',
'region' => 'us-west',
'architecture' => 'arm64',
'imagePullSecretSet' => 'dockerhub-credentials',
'secretSet' => 'voice-starter-secrets',
'autoScaling' => [
'minAgents' => 1,
'maxAgents' => 20
],
'krispViva' => [
'audioFilter' => 'tel'
],
'agentProfile' => 'agent-1x',
'maxSessionDuration' => 3600
]),
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.pipecat.daily.co/v1/agents"
payload := strings.NewReader("{\n \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\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.pipecat.daily.co/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipecat.daily.co/v1/agents")
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 \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\n}"
response = http.request(request)
puts response.read_body{
"name": "voice-starter",
"region": "us-west",
"ready": false,
"available": false,
"createdAt": "2025-04-19T01:20:27.564Z",
"updatedAt": "2025-04-19T01:20:27.572Z",
"desiredDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"activeDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"reconciledDeploymentId": null,
"activeDeploymentReady": false,
"autoScaling": {
"maxReplicas": 20,
"minReplicas": 1
},
"activeSessionCount": 0,
"deployment": {
"id": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"manifest": {
"apiVersion": "pipecatcloud.daily.co/v1",
"kind": "PCService",
"metadata": {
"name": "voice-starter",
"namespace": "tiny-ferret-maroon-123"
},
"spec": {
"dailyNodeType": "arm",
"image": "your-dockername/voice-starter:0.1",
"autoScaling": {
"minReplicas": 1,
"maxReplicas": 20
},
"imagePullSecretName": "dockerhub-credentials",
"envFromSecretNames": [
"voice-starter-secrets"
],
"resources": {
"cpu": "500m",
"memory": "1Gi"
},
"krispModels": {
"enabled": false
},
"krispViva": {
"audioFilters": true
},
"maxSessionDurationSeconds": 3600
}
},
"serviceId": "b59a68ee-61c8-4d99-9ceb-e99a3953bdac",
"createdAt": "2025-04-19T01:20:27.569Z",
"updatedAt": "2025-04-19T01:20:27.569Z"
},
"agentProfile": "agent-1x",
"krispViva": {
"audioFilter": "tel"
}
}Create an Agent
POST /agents creates a Pipecat Cloud agent from a container image with deployment configuration settings.
curl --request POST \
--url https://api.pipecat.daily.co/v1/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"serviceName": "voice-starter",
"image": "your-dockername/voice-starter:0.1",
"region": "us-west",
"architecture": "arm64",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"krispViva": {
"audioFilter": "tel"
},
"agentProfile": "agent-1x",
"maxSessionDuration": 3600
}
'import requests
url = "https://api.pipecat.daily.co/v1/agents"
payload = {
"serviceName": "voice-starter",
"image": "your-dockername/voice-starter:0.1",
"region": "us-west",
"architecture": "arm64",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"krispViva": { "audioFilter": "tel" },
"agentProfile": "agent-1x",
"maxSessionDuration": 3600
}
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({
serviceName: 'voice-starter',
image: 'your-dockername/voice-starter:0.1',
region: 'us-west',
architecture: 'arm64',
imagePullSecretSet: 'dockerhub-credentials',
secretSet: 'voice-starter-secrets',
autoScaling: {minAgents: 1, maxAgents: 20},
krispViva: {audioFilter: 'tel'},
agentProfile: 'agent-1x',
maxSessionDuration: 3600
})
};
fetch('https://api.pipecat.daily.co/v1/agents', 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.pipecat.daily.co/v1/agents",
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([
'serviceName' => 'voice-starter',
'image' => 'your-dockername/voice-starter:0.1',
'region' => 'us-west',
'architecture' => 'arm64',
'imagePullSecretSet' => 'dockerhub-credentials',
'secretSet' => 'voice-starter-secrets',
'autoScaling' => [
'minAgents' => 1,
'maxAgents' => 20
],
'krispViva' => [
'audioFilter' => 'tel'
],
'agentProfile' => 'agent-1x',
'maxSessionDuration' => 3600
]),
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.pipecat.daily.co/v1/agents"
payload := strings.NewReader("{\n \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\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.pipecat.daily.co/v1/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipecat.daily.co/v1/agents")
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 \"serviceName\": \"voice-starter\",\n \"image\": \"your-dockername/voice-starter:0.1\",\n \"region\": \"us-west\",\n \"architecture\": \"arm64\",\n \"imagePullSecretSet\": \"dockerhub-credentials\",\n \"secretSet\": \"voice-starter-secrets\",\n \"autoScaling\": {\n \"minAgents\": 1,\n \"maxAgents\": 20\n },\n \"krispViva\": {\n \"audioFilter\": \"tel\"\n },\n \"agentProfile\": \"agent-1x\",\n \"maxSessionDuration\": 3600\n}"
response = http.request(request)
puts response.read_body{
"name": "voice-starter",
"region": "us-west",
"ready": false,
"available": false,
"createdAt": "2025-04-19T01:20:27.564Z",
"updatedAt": "2025-04-19T01:20:27.572Z",
"desiredDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"activeDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"reconciledDeploymentId": null,
"activeDeploymentReady": false,
"autoScaling": {
"maxReplicas": 20,
"minReplicas": 1
},
"activeSessionCount": 0,
"deployment": {
"id": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"manifest": {
"apiVersion": "pipecatcloud.daily.co/v1",
"kind": "PCService",
"metadata": {
"name": "voice-starter",
"namespace": "tiny-ferret-maroon-123"
},
"spec": {
"dailyNodeType": "arm",
"image": "your-dockername/voice-starter:0.1",
"autoScaling": {
"minReplicas": 1,
"maxReplicas": 20
},
"imagePullSecretName": "dockerhub-credentials",
"envFromSecretNames": [
"voice-starter-secrets"
],
"resources": {
"cpu": "500m",
"memory": "1Gi"
},
"krispModels": {
"enabled": false
},
"krispViva": {
"audioFilters": true
},
"maxSessionDurationSeconds": 3600
}
},
"serviceId": "b59a68ee-61c8-4d99-9ceb-e99a3953bdac",
"createdAt": "2025-04-19T01:20:27.569Z",
"updatedAt": "2025-04-19T01:20:27.569Z"
},
"agentProfile": "agent-1x",
"krispViva": {
"audioFilter": "tel"
}
}Authorizations
Body
Name of the agent to create.
Must start with a lowercase letter or number, can include hyphens, and must end with a lowercase letter or number. No uppercase letters or special characters allowed. Maximum 54 characters.
54^[a-z0-9]([-a-z0-9]*[a-z0-9])$"my-voice-agent"
Target CPU architecture for the agent's containers: amd64 or arm64. Must be one of the architectures the target region supports (see the supported_architectures field on List available regions). If omitted, the region's default architecture is used. Daily-hosted regions currently support arm64 only. Set this explicitly when your image is built for a single architecture so it schedules on matching nodes instead of failing at startup.
amd64, arm64 "arm64"
Krisp VIVA noise cancellation configuration. Learn more.
Show child attributes
Show child attributes
The agent profile to use for resource allocation. Valid values are:
agent-1x: 0.5 vCPU and 1 GB of memory. Best for voice agents.agent-2x: 1 vCPU and 2 GB of memory. Well suited for voice and video agents or voice agents requiring extra processing.agent-3x: 1.5 vCPU and 3 GB of memory. Best for voice and video agents requiring extra processing or multiple video inputs.
In a self-hosted region, this may also name one of your organization's own profiles, or be omitted in favour of resources.
agent-1x, agent-2x, agent-3x "agent-1x"
Maximum session duration in seconds. When a session reaches this limit, the session is stopped: the bot is cancelled, with no opportunity for it to say goodbye first. Valid range: 60 to 14400 (4 hours). Defaults to 7200 (2 hours) when unset.
60 <= x <= 144003600
Response
Agent created successfully
Whether the agent can accept new sessions. True when any pods are ready to handle traffic, or when scaled to zero but healthy (requests will queue and trigger scale-up). During rolling updates, this may be true even if ready is false, as old pods continue serving while new ones validate.