SDK
import { createVoyantCloudClient } from "@voyant-travel/cloud-sdk";
const cloud = createVoyantCloudClient({ apiKey: process.env.VOYANT_API_KEY });
const token = await cloud.realtime.tokens.mint({
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
});curl --request POST \
--url https://api.voyant.travel/realtime/v1/tokens \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}'const response = await fetch("https://api.voyant.travel/realtime/v1/tokens", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/realtime/v1/tokens",
headers={
"Authorization": "Bearer <token>"
},
json={
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/realtime/v1/tokens",
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([
'clientId' => 'user_42',
'capabilities' => [
'orders:org_123' => [
'subscribe',
'presence'
]
],
'ttlSeconds' => 123
]),
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.voyant.travel/realtime/v1/tokens"
payload := strings.NewReader("{\n \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\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.voyant.travel/realtime/v1/tokens")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/realtime/v1/tokens")
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 \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"retryAfterMs": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Realtime
Mint a subscriber token
Mints a short-lived client token scoped to channels and capabilities, for use by browser subscribers connecting over the realtime WebSocket. Requires scope: realtime:tokens
POST
/
realtime
/
v1
/
tokens
SDK
import { createVoyantCloudClient } from "@voyant-travel/cloud-sdk";
const cloud = createVoyantCloudClient({ apiKey: process.env.VOYANT_API_KEY });
const token = await cloud.realtime.tokens.mint({
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
});curl --request POST \
--url https://api.voyant.travel/realtime/v1/tokens \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}'const response = await fetch("https://api.voyant.travel/realtime/v1/tokens", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/realtime/v1/tokens",
headers={
"Authorization": "Bearer <token>"
},
json={
"clientId": "user_42",
"capabilities": {
"orders:org_123": [
"subscribe",
"presence"
]
},
"ttlSeconds": 123
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/realtime/v1/tokens",
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([
'clientId' => 'user_42',
'capabilities' => [
'orders:org_123' => [
'subscribe',
'presence'
]
],
'ttlSeconds' => 123
]),
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.voyant.travel/realtime/v1/tokens"
payload := strings.NewReader("{\n \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\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.voyant.travel/realtime/v1/tokens")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/realtime/v1/tokens")
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 \"clientId\": \"user_42\",\n \"capabilities\": {\n \"orders:org_123\": [\n \"subscribe\",\n \"presence\"\n ]\n },\n \"ttlSeconds\": 123\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"retryAfterMs": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.
Body
application/json
Stable subscriber identity; surfaces as the presence clientId.
Example:
"user_42"
Capability grants keyed by channel name or trailing-wildcard pattern (e.g. admin:*).
Show child attributes
Show child attributes
Example:
{
"orders:org_123": ["subscribe", "presence"]
}
Token lifetime in seconds. Default 3600, max 86400.
Required range:
x <= 86400⌘I