Skip to main content
POST
/
{agentName}
/
start
Start a service instance
curl --request POST \
  --url https://api.pipecat.daily.co/v1/public/{agentName}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "createDailyRoom": true,
  "dailyRoomProperties": {
    "enable_recording": "cloud"
  },
  "dailyMeetingTokenProperties": {
    "is_owner": true,
    "enable_auto_recording": true
  },
  "body": {
    "foo": "bar"
  }
}'
{
  "dailyRoom": "https://cloud-354b1860310a444ba0f528b6a2f467c4.daily.co/qZbK9nyXCDCmQ0zDDZta",
  "dailyToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "sessionId": "639f91d8-d511-4677-a83b-bd7564d5d92f"
}
This endpoint starts a new instance of a deployed agent. You can optionally create a Daily room for the service to connect to.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
agentName
string
required

Body

application/json
​
createDailyRoom
boolean
default:false
Example:
​
dailyRoomProperties
object
Example:
​
dailyMeetingTokenProperties
object
Example:
​
body
object
Example:

Response

​
dailyRoom
string
Example:
​
dailyToken
string
Example:
​
sessionId
string
Example: