Skip to main content
GET
/
agents
/
{agentName}
Get agent details
curl --request GET \
  --url https://api.pipecat.daily.co/v1/agents/{agentName} \
  --header 'Authorization: Bearer <token>'
{
  "name": "voice-starter",
  "region": "us-west",
  "ready": true,
  "available": true,
  "createdAt": "2025-04-09T15:01:17.414Z",
  "updatedAt": "2025-04-18T20:29:19.181Z",
  "activeDeploymentId": "4cab03c7-8f53-418d-9c3c-91a1265d179e",
  "activeDeploymentReady": true,
  "autoScaling": {
    "maxReplicas": 10,
    "minReplicas": 1
  },
  "activeSessionCount": 0,
  "deployment": {
    "id": "4cab03c7-8f53-418d-9c3c-91a1265d179e",
    "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": 10
        },
        "envFromSecretNames": [
          "voice-starter-secrets"
        ],
        "krispModels": {
          "enabled": false
        },
        "krispViva": {
          "audioFilters": true,
          "version": "20251010"
        },
        "enableManagedKeys": {
          "enabled": false
        }
      }
    },
    "serviceId": "c359e1ea-64d6-4bcf-a7c6-28d3bd1c8909",
    "createdAt": "2025-04-18T20:29:19.177Z",
    "updatedAt": "2025-04-18T20:29:19.177Z"
  },
  "agentProfile": "agent-1x"
}

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 retrieve

Response

Agent details retrieved successfully

​
name
string

Name of the agent

​
region
string

The region where the agent is deployed

​
ready
boolean

Whether the latest deployment has passed validation and is ready. For scale-to-zero agents, this is true even when scaled down to zero replicas.

​
available
boolean

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.

​
createdAt
string<date-time>

Creation timestamp of the agent

​
updatedAt
string<date-time>

Last update timestamp

​
activeDeploymentId
string

ID of the active deployment

​
activeDeploymentReady
boolean
deprecated

Deprecated: Use ready instead. Whether the active deployment is ready. This field is redundant with ready and will be removed in a future version.

​
autoScaling
object
​
activeSessionCount
integer

Number of active sessions

​
deployment
object

Details of the current deployment

​
agentProfile
string | null

The agent profile used for resource allocation