POST
/
{agent_name}
/
start
curl --request POST \
  --url https://api.pipecat.daily.co/v1/public/{agent_name}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "createDailyRoom": true,
  "body": {}
}'
{
  "dailyRoom": "https://cloud-354b1860310a444ba0f528b6a2f467c4.daily.co/qZbK9nyXCDCmQ0zDDZta",
  "dailyToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

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

Authentication using a Pipecat Cloud API token.

Path Parameters

​
agent_name
string
required

Name of the agent to start

Body

application/json
​
createDailyRoom
boolean

Whether to create a Daily room for the service instance

​
body
object

Arbitrary user data / configuration object to pass to the service instance. Accessible as the first parameter of the bot method or custom entry point. See the Starting Sessions docs for more information.

Response

200
application/json
Service started successfully
​
dailyRoom
string

URL of the created Daily room (if createDailyRoom was set to true)

Example:

"https://cloud-354b1860310a444ba0f528b6a2f467c4.daily.co/qZbK9nyXCDCmQ0zDDZta"

​
dailyToken
string

Token to access the Daily room (if createDailyRoom was set to true)

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."