POST
/
agents
/
{agentName}
curl --request POST \
  --url https://api.pipecat.daily.co/v1/agents/{agentName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "image": "your-dockername/voice-starter:0.1",
  "nodeType": "arm",
  "imagePullSecretSet": "dockerhub-credentials",
  "secretSet": "voice-starter-secrets",
  "autoScaling": {
    "minAgents": 1,
    "maxAgents": 10
  },
  "enableKrisp": false
}'
{
  "name": "voice-starter",
  "ready": true,
  "createdAt": "2025-04-19T01:20:27.564Z",
  "updatedAt": "2025-04-19T01:25:47.229Z",
  "activeDeploymentId": "19db578d-808c-420a-a047-87edde4410c1",
  "activeDeploymentReady": false,
  "autoScaling": {
    "concurrency": 1,
    "maxReplicas": 10,
    "minReplicas": 1,
    "scaleToZeroTime": "5m"
  },
  "activeSessionCount": 0,
  "deployment": {
    "id": "19db578d-808c-420a-a047-87edde4410c1",
    "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": {
          "concurrency": 1,
          "minReplicas": 1,
          "maxReplicas": 10
        },
        "envFromSecretNames": [
          "voice-starter-secrets"
        ],
        "krispModels": {
          "enabled": false
        }
      }
    },
    "serviceId": "b59a68ee-61c8-4d99-9ceb-e99a3953bdac",
    "createdAt": "2025-04-19T01:25:47.225Z",
    "updatedAt": "2025-04-19T01:25:47.225Z"
  }
}

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
agentName
string
required

Name of the agent to update

Body

application/json
​
image
string

The container image to use for the agent

Example:

"your-username/my-agent:latest"

​
nodeType
string
default:arm

The type of node to run the agent on. Only arm is supported at this time.

Example:

"arm"

​
imagePullSecretSet
string

The name of the image pull secret set to use

Example:

"dockerhub-credentials"

​
secretSet
string

The name of the secret set to use

Example:

"my-agent-secrets"

​
autoScaling
object

Auto-scaling configuration for the agent

​
enableKrisp
boolean

Whether to enable Krisp noise cancellation

Example:

false

Response

200
application/json
Agent deployment updated successfully
​
name
string

Name of the agent

​
ready
boolean

Whether the agent is ready to accept sessions

​
createdAt
string

Creation timestamp of the agent

​
updatedAt
string

Last update timestamp

​
activeDeploymentId
string

ID of the active deployment

​
activeDeploymentReady
boolean

Whether the active deployment is ready

​
autoScaling
object
​
activeSessionCount
integer

Number of active sessions

​
deployment
object | null

Details of the current deployment