SDK
import { createVoyantCloudClient } from "@voyant-travel/cloud-sdk";
const cloud = createVoyantCloudClient({ apiKey: process.env.VOYANT_API_KEY });
const result = await cloud.browser.sessions.runCommands("<id>", {
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
});curl --request POST \
--url https://api.voyant.travel/browser/v1/sessions/<id>/commands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}'const response = await fetch("https://api.voyant.travel/browser/v1/sessions/<id>/commands", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/browser/v1/sessions/<id>/commands",
headers={
"Authorization": "Bearer <token>"
},
json={
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": True,
"secure": True,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/browser/v1/sessions/{id}/commands",
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([
'commands' => [
[
'url' => '<string>',
'selector' => '<string>',
'text' => '<string>',
'values' => [
'<string>'
],
'ms' => 123,
'script' => '<string>',
'urls' => [
'<string>'
],
'cookies' => [
[
'name' => '<string>',
'value' => '<string>',
'url' => '<string>',
'domain' => '<string>',
'path' => '<string>',
'expires' => 123,
'httpOnly' => true,
'secure' => true
]
],
'width' => 123,
'height' => 123,
'deviceScaleFactor' => 123,
'userAgent' => '<string>',
'headers' => [
],
'options' => [
]
]
]
]),
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/browser/v1/sessions/{id}/commands"
payload := strings.NewReader("{\n \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\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/browser/v1/sessions/{id}/commands")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/browser/v1/sessions/{id}/commands")
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 \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"sessionId": "<string>",
"results": [
{
"op": "<string>",
"durationMs": 123,
"ok": true,
"result": "<unknown>",
"error": "<string>"
}
],
"totalMs": 123
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>",
"retryAfterMs": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Browser
Run commands in a session
Runs an ordered list of browser automation commands in an existing session and returns the per-command results. Requires scope: browser:sessions
POST
/
browser
/
v1
/
sessions
/
{id}
/
commands
SDK
import { createVoyantCloudClient } from "@voyant-travel/cloud-sdk";
const cloud = createVoyantCloudClient({ apiKey: process.env.VOYANT_API_KEY });
const result = await cloud.browser.sessions.runCommands("<id>", {
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
});curl --request POST \
--url https://api.voyant.travel/browser/v1/sessions/<id>/commands \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}'const response = await fetch("https://api.voyant.travel/browser/v1/sessions/<id>/commands", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer <token>"
},
body: JSON.stringify({
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": true,
"secure": true,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.voyant.travel/browser/v1/sessions/<id>/commands",
headers={
"Authorization": "Bearer <token>"
},
json={
"commands": [
{
"op": "goto",
"url": "<string>",
"selector": "<string>",
"text": "<string>",
"values": [
"<string>"
],
"ms": 123,
"script": "<string>",
"urls": [
"<string>"
],
"cookies": [
{
"name": "<string>",
"value": "<string>",
"url": "<string>",
"domain": "<string>",
"path": "<string>",
"expires": 123,
"httpOnly": True,
"secure": True,
"sameSite": "Strict"
}
],
"width": 123,
"height": 123,
"deviceScaleFactor": 123,
"userAgent": "<string>",
"headers": {},
"options": {}
}
]
}
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voyant.travel/browser/v1/sessions/{id}/commands",
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([
'commands' => [
[
'url' => '<string>',
'selector' => '<string>',
'text' => '<string>',
'values' => [
'<string>'
],
'ms' => 123,
'script' => '<string>',
'urls' => [
'<string>'
],
'cookies' => [
[
'name' => '<string>',
'value' => '<string>',
'url' => '<string>',
'domain' => '<string>',
'path' => '<string>',
'expires' => 123,
'httpOnly' => true,
'secure' => true
]
],
'width' => 123,
'height' => 123,
'deviceScaleFactor' => 123,
'userAgent' => '<string>',
'headers' => [
],
'options' => [
]
]
]
]),
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/browser/v1/sessions/{id}/commands"
payload := strings.NewReader("{\n \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\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/browser/v1/sessions/{id}/commands")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voyant.travel/browser/v1/sessions/{id}/commands")
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 \"commands\": [\n {\n \"url\": \"<string>\",\n \"selector\": \"<string>\",\n \"text\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"ms\": 123,\n \"script\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"cookies\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"url\": \"<string>\",\n \"domain\": \"<string>\",\n \"path\": \"<string>\",\n \"expires\": 123,\n \"httpOnly\": true,\n \"secure\": true\n }\n ],\n \"width\": 123,\n \"height\": 123,\n \"deviceScaleFactor\": 123,\n \"userAgent\": \"<string>\",\n \"headers\": {},\n \"options\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"sessionId": "<string>",
"results": [
{
"op": "<string>",
"durationMs": 123,
"ok": true,
"result": "<unknown>",
"error": "<string>"
}
],
"totalMs": 123
}{
"error": "<string>"
}{
"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.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
⌘I