Mint a hosted widget voice session
curl --request POST \
--url https://api.pyai.com/public/widgets/{publicId}/session \
--header 'Origin: <origin>'import requests
url = "https://api.pyai.com/public/widgets/{publicId}/session"
headers = {"Origin": "<origin>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Origin: '<origin>'}};
fetch('https://api.pyai.com/public/widgets/{publicId}/session', 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.pyai.com/public/widgets/{publicId}/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Origin: <origin>"
],
]);
$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.pyai.com/public/widgets/{publicId}/session"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Origin", "<origin>")
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.pyai.com/public/widgets/{publicId}/session")
.header("Origin", "<origin>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/public/widgets/{publicId}/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Origin"] = '<origin>'
response = http.request(request)
puts response.read_body{
"object": "omni.session",
"token": "pyai_live_sess_a1B2…",
"expires_at": 123,
"url": "wss://api.pyai.com/v1/omni?format=pcm16&rate=24000",
"session_label": "<string>"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "invalid_request_error",
"param": "<string>"
}
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}Agents
Mint a hosted widget voice session
Validates the published widget, exact browser Origin, Agent/account status, credit posture, and durable per-widget/per-IP daily limits, then returns one short-lived origin-locked omni:session token. The request body cannot select an organization, project, or Agent.
POST
/
public
/
widgets
/
{publicId}
/
session
Mint a hosted widget voice session
curl --request POST \
--url https://api.pyai.com/public/widgets/{publicId}/session \
--header 'Origin: <origin>'import requests
url = "https://api.pyai.com/public/widgets/{publicId}/session"
headers = {"Origin": "<origin>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Origin: '<origin>'}};
fetch('https://api.pyai.com/public/widgets/{publicId}/session', 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.pyai.com/public/widgets/{publicId}/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Origin: <origin>"
],
]);
$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.pyai.com/public/widgets/{publicId}/session"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Origin", "<origin>")
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.pyai.com/public/widgets/{publicId}/session")
.header("Origin", "<origin>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pyai.com/public/widgets/{publicId}/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Origin"] = '<origin>'
response = http.request(request)
puts response.read_body{
"object": "omni.session",
"token": "pyai_live_sess_a1B2…",
"expires_at": 123,
"url": "wss://api.pyai.com/v1/omni?format=pcm16&rate=24000",
"session_label": "<string>"
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "invalid_request_error",
"param": "<string>"
}
}{
"title": "<string>",
"status": 123,
"type": "<string>",
"detail": "<string>",
"request_id": "<string>"
}Headers
Path Parameters
Pattern:
^wdgt_[A-Za-z0-9_-]{32,64}$Response
Short-lived widget session
Example:
"omni.session"
The ephemeral session token. Offer it as the WebSocket subprotocol pyai-key.<token> after the pyai.v1 marker. Short-lived and origin-locked; safe to hand to the browser.
Example:
"pyai_live_sess_a1B2…"
Token expiry, Unix epoch milliseconds.
The Omni realtime WebSocket URL to connect to.
Example:
"wss://api.pyai.com/v1/omni?format=pcm16&rate=24000"
Echoed back when supplied on the request.