Skip to main content
GET
Get WebRTC connections

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

ids
string[]

Filter by WebRTC connection IDs

productIds
string[]

Filter by product IDs

names
string[]

Filter by WebRTC connection names (exact match, multiple)

name
string

Filter by WebRTC connection name (partial match)

agentNames
string[]

Filter by agent names (exact match, multiple)

agentName
string

Filter by agent name (partial match)

sort
string[]

Sort instructions (field and direction pairs)

limit
integer

Maximum number of results

offset
integer

Number of results to skip

fromCreatedAt
string<date-time>

Filter WebRTC connections created at or after this timestamp (ISO 8601 format)

toCreatedAt
string<date-time>

Filter WebRTC connections created at or before this timestamp (ISO 8601 format)

Response

WebRTC connections retrieved successfully

productId
string
required
Example:

"prod_123"

name
string
required
Example:

"Support agent (WebRTC)"

agentName
string
required

Name of your deployed Pipecat Cloud agent. Must match that agent's deployed name exactly. Galtea passes it to the Pipecat Cloud /start call to launch the session; if no deployed agent has this name, /start fails.

Example:

"my-voice-agent"

id
string
Example:

"webRtcConnection_123"

userId
string | null
Example:

"user_123"

hasApiKey
boolean
read-only

Whether a Pipecat Cloud API key is stored for this connection.

Example:

true

agentSpeaksFirst
boolean
default:false

Whether the voice agent opens the conversation once the session connects. false (default) means the simulated caller speaks first; true suits interviewer-style agents that greet first.

Example:

false

createdAt
string<date-time>
deletedAt
string<date-time> | null