start run
curl --request POST \
--url https://engine.example.com/api/v1/workloads/{workload_id}/runs \
--header 'Content-Type: application/json' \
--data '
{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_window": {
"end_unix_millis": 123,
"start_unix_millis": 123,
"timezone": "<string>"
},
"expected_revision": 1,
"parameters": {},
"xray": true
}
'import requests
url = "https://engine.example.com/api/v1/workloads/{workload_id}/runs"
payload = {
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_window": {
"end_unix_millis": 123,
"start_unix_millis": 123,
"timezone": "<string>"
},
"expected_revision": 1,
"parameters": {},
"xray": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
submission_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
data_window: {end_unix_millis: 123, start_unix_millis: 123, timezone: '<string>'},
expected_revision: 1,
parameters: {},
xray: true
})
};
fetch('https://engine.example.com/api/v1/workloads/{workload_id}/runs', 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://engine.example.com/api/v1/workloads/{workload_id}/runs",
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([
'submission_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'data_window' => [
'end_unix_millis' => 123,
'start_unix_millis' => 123,
'timezone' => '<string>'
],
'expected_revision' => 1,
'parameters' => [
],
'xray' => true
]),
CURLOPT_HTTPHEADER => [
"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://engine.example.com/api/v1/workloads/{workload_id}/runs"
payload := strings.NewReader("{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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://engine.example.com/api/v1/workloads/{workload_id}/runs")
.header("Content-Type", "application/json")
.body("{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://engine.example.com/api/v1/workloads/{workload_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}"
response = http.request(request)
puts response.read_body{
"submission_id": "44444444-4444-4444-8444-444444444444",
"workload_id": "22222222-2222-4222-8222-222222222222",
"workload_run_id": "33333333-3333-4333-8333-333333333333"
}{
"error": {
"code": "invalid_request",
"message": "Check the request fields"
}
}Start run
start run. POST /api/v1/workloads//runs. Submit a workload run; poll get_run and list_tasks. Reuse submission_id on retry. Assistant calls must include expected_revisi
start run
curl --request POST \
--url https://engine.example.com/api/v1/workloads/{workload_id}/runs \
--header 'Content-Type: application/json' \
--data '
{
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_window": {
"end_unix_millis": 123,
"start_unix_millis": 123,
"timezone": "<string>"
},
"expected_revision": 1,
"parameters": {},
"xray": true
}
'import requests
url = "https://engine.example.com/api/v1/workloads/{workload_id}/runs"
payload = {
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data_window": {
"end_unix_millis": 123,
"start_unix_millis": 123,
"timezone": "<string>"
},
"expected_revision": 1,
"parameters": {},
"xray": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
submission_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
data_window: {end_unix_millis: 123, start_unix_millis: 123, timezone: '<string>'},
expected_revision: 1,
parameters: {},
xray: true
})
};
fetch('https://engine.example.com/api/v1/workloads/{workload_id}/runs', 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://engine.example.com/api/v1/workloads/{workload_id}/runs",
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([
'submission_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'data_window' => [
'end_unix_millis' => 123,
'start_unix_millis' => 123,
'timezone' => '<string>'
],
'expected_revision' => 1,
'parameters' => [
],
'xray' => true
]),
CURLOPT_HTTPHEADER => [
"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://engine.example.com/api/v1/workloads/{workload_id}/runs"
payload := strings.NewReader("{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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://engine.example.com/api/v1/workloads/{workload_id}/runs")
.header("Content-Type", "application/json")
.body("{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://engine.example.com/api/v1/workloads/{workload_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"submission_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"data_window\": {\n \"end_unix_millis\": 123,\n \"start_unix_millis\": 123,\n \"timezone\": \"<string>\"\n },\n \"expected_revision\": 1,\n \"parameters\": {},\n \"xray\": true\n}"
response = http.request(request)
puts response.read_body{
"submission_id": "44444444-4444-4444-8444-444444444444",
"workload_id": "22222222-2222-4222-8222-222222222222",
"workload_run_id": "33333333-3333-4333-8333-333333333333"
}{
"error": {
"code": "invalid_request",
"message": "Check the request fields"
}
}ReferenceApplies to: Unified engine deployments
Related guidance
Addresses and access · Request identity · Errors and recovery · Pagination and resultsPath Parameters
Body
application/json
Last modified on November 4, 2026