Skip to main content
GET
/
{serviceName}
/
sessions
/
{sessionId}
/
{path}
Send GET request to session
curl --request GET \
  --url https://api.pipecat.daily.co/v1/public/{serviceName}/sessions/{sessionId}/{path} \
  --header 'Authorization: Bearer <token>'
{
  "status": "active",
  "message_count": 5,
  "user_name": "Alice"
}
Send HTTP requests to endpoints defined in your running bot. Supports GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD methods.

​
Request Headers

Headers are forwarded to your bot with these exceptions:
  • host - Excluded
  • content-length - Excluded
  • authorization - Excluded (authentication is handled by the API gateway)
Requires base image version 0.1.2 or later. See the Session API guide for setup instructions and examples.

Authorizations

​
Authorization
string
header
required

Authentication using a Pipecat Cloud public API key.

Generate a public API key from your Dashboard (Settings > API Keys > Public > Create key) and include it as a Bearer token in the Authorization header.

Path Parameters

​
serviceName
string
required

Name of the deployed agent

​
sessionId
string<uuid>
required

Session ID returned from the start endpoint

​
path
string
required

The endpoint path defined in your bot using the @app decorator

Response

Successful response from the bot

Response from your bot endpoint. The schema depends on what your bot returns.