REST Reference
Create an Agent
Create a new agent with a container image and configuration settings.
POST
https://api.pipecat.daily.co/v1
/
agents
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",
"nodeType": "arm",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"enableKrisp": false
}'
{
"name": "voice-starter",
"ready": false,
"createdAt": "2025-04-19T01:20:27.564Z",
"updatedAt": "2025-04-19T01:20:27.572Z",
"activeDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"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",
"clusterLocal": true,
"image": "your-dockername/voice-starter:0.1",
"autoScaling": {
"minReplicas": 1,
"maxReplicas": 20
},
"envFromSecretNames": [
"voice-starter-secrets"
],
"krispModels": {
"enabled": false
}
}
},
"serviceId": "b59a68ee-61c8-4d99-9ceb-e99a3953bdac",
"createdAt": "2025-04-19T01:20:27.569Z",
"updatedAt": "2025-04-19T01:20:27.569Z"
}
}
Authorizations
Authentication requires a Pipecat Cloud Private API token. Generate a Private API key from your Dashboard (Settings > API Keys > Private > Create key) and include it as a Bearer token in the Authorization header.
Body
application/json
Response
200
application/json
Agent created successfully
The response is of type object
.
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",
"nodeType": "arm",
"imagePullSecretSet": "dockerhub-credentials",
"secretSet": "voice-starter-secrets",
"autoScaling": {
"minAgents": 1,
"maxAgents": 20
},
"enableKrisp": false
}'
{
"name": "voice-starter",
"ready": false,
"createdAt": "2025-04-19T01:20:27.564Z",
"updatedAt": "2025-04-19T01:20:27.572Z",
"activeDeploymentId": "13c0be89-5ae8-4b0b-ad22-79565e11de3b",
"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",
"clusterLocal": true,
"image": "your-dockername/voice-starter:0.1",
"autoScaling": {
"minReplicas": 1,
"maxReplicas": 20
},
"envFromSecretNames": [
"voice-starter-secrets"
],
"krispModels": {
"enabled": false
}
}
},
"serviceId": "b59a68ee-61c8-4d99-9ceb-e99a3953bdac",
"createdAt": "2025-04-19T01:20:27.569Z",
"updatedAt": "2025-04-19T01:20:27.569Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.