Skip to main content
POST
/
webRtcConnections
Create WebRTC connection
curl --request POST \
  --url https://api.galtea.ai/webRtcConnections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "prod_123",
  "name": "Support agent (WebRTC)",
  "apiKey": "pk_...",
  "agentName": "my-voice-agent",
  "id": "webRtcConnection_123",
  "userId": "user_123",
  "agentSpeaksFirst": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
'
{
  "productId": "prod_123",
  "name": "Support agent (WebRTC)",
  "agentName": "my-voice-agent",
  "id": "webRtcConnection_123",
  "userId": "user_123",
  "hasApiKey": true,
  "agentSpeaksFirst": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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-....

Body

application/json
​
productId
string
required
Example:

"prod_123"

​
name
string
required
Example:

"Support agent (WebRTC)"

​
apiKey
string
required
write-only

Pipecat Cloud PUBLIC API key (pk_...) Galtea uses to provision a room via the runtime /start call. This is NOT the pcc_pat_ Personal Access Token used to deploy agents. Encrypted at rest and never returned; read hasApiKey to know whether one is set. On update, omit it to keep the stored key.

Example:

"pk_..."

​
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"

​
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

Response

WebRTC connection created 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