Submit an automation task
curl --request POST \
--url https://api.example.com/api/v1/inference \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"endpoint_name": "<string>",
"input_parameters": {},
"unique_parameter_names": [
"<string>"
],
"secure_parameters": {},
"rdp_parameter": {
"host": "<string>",
"username": "<string>",
"password": "<string>"
},
"max_timeout_in_minutes": 10,
"use_proxy": false,
"is_dedicated": false,
"task_callback_url": "<string>",
"task_callback_api_key": "<string>",
"max_parallelism": 1,
"per_login_parallelism": 1,
"priority": 123
}
'import requests
url = "https://api.example.com/api/v1/inference"
payload = {
"endpoint_name": "<string>",
"input_parameters": {},
"unique_parameter_names": ["<string>"],
"secure_parameters": {},
"rdp_parameter": {
"host": "<string>",
"username": "<string>",
"password": "<string>"
},
"max_timeout_in_minutes": 10,
"use_proxy": False,
"is_dedicated": False,
"task_callback_url": "<string>",
"task_callback_api_key": "<string>",
"max_parallelism": 1,
"per_login_parallelism": 1,
"priority": 123
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpoint_name: '<string>',
input_parameters: {},
unique_parameter_names: ['<string>'],
secure_parameters: {},
rdp_parameter: {host: '<string>', username: '<string>', password: '<string>'},
max_timeout_in_minutes: 10,
use_proxy: false,
is_dedicated: false,
task_callback_url: '<string>',
task_callback_api_key: '<string>',
max_parallelism: 1,
per_login_parallelism: 1,
priority: 123
})
};
fetch('https://api.example.com/api/v1/inference', 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.example.com/api/v1/inference",
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([
'endpoint_name' => '<string>',
'input_parameters' => [
],
'unique_parameter_names' => [
'<string>'
],
'secure_parameters' => [
],
'rdp_parameter' => [
'host' => '<string>',
'username' => '<string>',
'password' => '<string>'
],
'max_timeout_in_minutes' => 10,
'use_proxy' => false,
'is_dedicated' => false,
'task_callback_url' => '<string>',
'task_callback_api_key' => '<string>',
'max_parallelism' => 1,
'per_login_parallelism' => 1,
'priority' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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.example.com/api/v1/inference"
payload := strings.NewReader("{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.example.com/api/v1/inference")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/inference")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"task_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}HTTP API
Submit an automation task
Queue a browser automation task for asynchronous execution. Returns immediately with a task_id; the automation runs in the background. Use priority to control queue position within your login group — lower numbers run first, null/omitted runs last.
POST
/
api
/
v1
/
inference
Submit an automation task
curl --request POST \
--url https://api.example.com/api/v1/inference \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"endpoint_name": "<string>",
"input_parameters": {},
"unique_parameter_names": [
"<string>"
],
"secure_parameters": {},
"rdp_parameter": {
"host": "<string>",
"username": "<string>",
"password": "<string>"
},
"max_timeout_in_minutes": 10,
"use_proxy": false,
"is_dedicated": false,
"task_callback_url": "<string>",
"task_callback_api_key": "<string>",
"max_parallelism": 1,
"per_login_parallelism": 1,
"priority": 123
}
'import requests
url = "https://api.example.com/api/v1/inference"
payload = {
"endpoint_name": "<string>",
"input_parameters": {},
"unique_parameter_names": ["<string>"],
"secure_parameters": {},
"rdp_parameter": {
"host": "<string>",
"username": "<string>",
"password": "<string>"
},
"max_timeout_in_minutes": 10,
"use_proxy": False,
"is_dedicated": False,
"task_callback_url": "<string>",
"task_callback_api_key": "<string>",
"max_parallelism": 1,
"per_login_parallelism": 1,
"priority": 123
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpoint_name: '<string>',
input_parameters: {},
unique_parameter_names: ['<string>'],
secure_parameters: {},
rdp_parameter: {host: '<string>', username: '<string>', password: '<string>'},
max_timeout_in_minutes: 10,
use_proxy: false,
is_dedicated: false,
task_callback_url: '<string>',
task_callback_api_key: '<string>',
max_parallelism: 1,
per_login_parallelism: 1,
priority: 123
})
};
fetch('https://api.example.com/api/v1/inference', 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.example.com/api/v1/inference",
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([
'endpoint_name' => '<string>',
'input_parameters' => [
],
'unique_parameter_names' => [
'<string>'
],
'secure_parameters' => [
],
'rdp_parameter' => [
'host' => '<string>',
'username' => '<string>',
'password' => '<string>'
],
'max_timeout_in_minutes' => 10,
'use_proxy' => false,
'is_dedicated' => false,
'task_callback_url' => '<string>',
'task_callback_api_key' => '<string>',
'max_parallelism' => 1,
'per_login_parallelism' => 1,
'priority' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$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.example.com/api/v1/inference"
payload := strings.NewReader("{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
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.example.com/api/v1/inference")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/inference")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"endpoint_name\": \"<string>\",\n \"input_parameters\": {},\n \"unique_parameter_names\": [\n \"<string>\"\n ],\n \"secure_parameters\": {},\n \"rdp_parameter\": {\n \"host\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n },\n \"max_timeout_in_minutes\": 10,\n \"use_proxy\": false,\n \"is_dedicated\": false,\n \"task_callback_url\": \"<string>\",\n \"task_callback_api_key\": \"<string>\",\n \"max_parallelism\": 1,\n \"per_login_parallelism\": 1,\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"task_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I