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"
}
'
import requests

url = "https://api.galtea.ai/webRtcConnections"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.galtea.ai/webRtcConnections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.galtea.ai/webRtcConnections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galtea.ai/webRtcConnections"

	payload := strings.NewReader("{\n  \"productId\": \"prod_123\",\n  \"name\": \"Support agent (WebRTC)\",\n  \"apiKey\": \"pk_...\",\n  \"agentName\": \"my-voice-agent\",\n  \"id\": \"webRtcConnection_123\",\n  \"userId\": \"user_123\",\n  \"agentSpeaksFirst\": false,\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.galtea.ai/webRtcConnections")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"productId\": \"prod_123\",\n  \"name\": \"Support agent (WebRTC)\",\n  \"apiKey\": \"pk_...\",\n  \"agentName\": \"my-voice-agent\",\n  \"id\": \"webRtcConnection_123\",\n  \"userId\": \"user_123\",\n  \"agentSpeaksFirst\": false,\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/webRtcConnections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"productId\": \"prod_123\",\n  \"name\": \"Support agent (WebRTC)\",\n  \"apiKey\": \"pk_...\",\n  \"agentName\": \"my-voice-agent\",\n  \"id\": \"webRtcConnection_123\",\n  \"userId\": \"user_123\",\n  \"agentSpeaksFirst\": false,\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "error": "Error type",
  "message": "Error message description"
}

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