Skip to main content
GET
Send GET request to session
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)
  • accept-encoding - Replaced with identity. Return your response uncompressed: a gzip or deflate response is decompressed for the caller, and other codings aren’t supported

Redirects

A redirect from your bot is followed only if it stays on your bot’s own server, such as the redirect FastAPI sends to add a trailing slash. Up to 5 redirects are followed per request. Use a relative path in Location. An absolute URL has to match the address Pipecat Cloud used to reach your bot, so one naming localhost or using https:// is treated as leaving the server. A redirect anywhere else, or a longer chain, returns 502 to the caller. To send a caller elsewhere, return the URL in your response body.
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.