Skip to main content
GET
/
webRtcConnections
Get WebRTC connections
curl --request GET \
  --url https://api.galtea.ai/webRtcConnections \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.galtea.ai/webRtcConnections")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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