Skip to main content
Create a Pipecat avatar media session

Authorizations

Authorization
string
header
required

Live API key minted in the dashboard. Pass as Authorization: Bearer sk_live_…. Keys are scoped to a single environment (staging / prod).

Body

application/json

Start request for a Pipecat avatar media session.

avatar_id
string
required

Stable av_... avatar id.

idle_timeout_seconds
integer
default:30
Required range: 1 <= x <= 600
max_duration_seconds
integer | null
Required range: 1 <= x <= 3600
metadata
object
quality
enum<string>
default:standard

Output quality tier.

Available options:
mock,
lite,
standard,
pro
relay_mode
string
default:websocket
Allowed value: "websocket"

Response

Successful Response

Pipecat avatar media session.

relay
PipecatWebSocketRelayView · object
required

Short-lived direct media connection details for the Pipecat plugin.

session
Session · object
required

Public session resource — what GET /v1/sessions/{id} returns.

Example:
object
string
default:pipecat.session
Allowed value: "pipecat.session"