Preview and retain an exact simulation plan
curl --request POST \
--url https://api.firedrill.run/v1/projects/{projectId}/simulation-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"drillIds": [
"<string>"
],
"concurrency": 1,
"retries": 0,
"environmentId": "<string>",
"buildHash": "<string>",
"toolSetupId": "<string>",
"seeds": [
"<string>"
],
"repetitions": 5000,
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"name": "<string>"
}
]
}
]
}
'import requests
url = "https://api.firedrill.run/v1/projects/{projectId}/simulation-plans"
payload = {
"drillIds": ["<string>"],
"concurrency": 1,
"retries": 0,
"environmentId": "<string>",
"buildHash": "<string>",
"toolSetupId": "<string>",
"seeds": ["<string>"],
"repetitions": 5000,
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"name": "<string>"
}
]
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
drillIds: ['<string>'],
concurrency: 1,
retries: 0,
environmentId: '<string>',
buildHash: '<string>',
toolSetupId: '<string>',
seeds: ['<string>'],
repetitions: 5000,
browserInvocations: [
{
targetId: '<string>',
testId: '<string>',
expectedTestVersion: 0,
role: {kind: 'tool_ui', packageId: '<string>', instanceId: '<string>'},
mode: 'replay',
timeoutMs: 120000,
maxActions: 100,
captureConsent: 'include-sensitive-content',
captureMask: [{by: 'role', name: '<string>'}]
}
]
})
};
fetch('https://api.firedrill.run/v1/projects/{projectId}/simulation-plans', 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.firedrill.run/v1/projects/{projectId}/simulation-plans",
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([
'drillIds' => [
'<string>'
],
'concurrency' => 1,
'retries' => 0,
'environmentId' => '<string>',
'buildHash' => '<string>',
'toolSetupId' => '<string>',
'seeds' => [
'<string>'
],
'repetitions' => 5000,
'browserInvocations' => [
[
'targetId' => '<string>',
'testId' => '<string>',
'expectedTestVersion' => 0,
'role' => [
'kind' => 'tool_ui',
'packageId' => '<string>',
'instanceId' => '<string>'
],
'mode' => 'replay',
'timeoutMs' => 120000,
'maxActions' => 100,
'captureConsent' => 'include-sensitive-content',
'captureMask' => [
[
'by' => 'role',
'name' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.firedrill.run/v1/projects/{projectId}/simulation-plans"
payload := strings.NewReader("{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.firedrill.run/v1/projects/{projectId}/simulation-plans")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/projects/{projectId}/simulation-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"schemaVersion": 1,
"planId": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"buildHash": "<string>",
"digest": "<string>",
"concurrency": 32,
"retries": 5,
"logicalCases": 5000,
"maxAttempts": 55000,
"createdBy": "<string>",
"createdAtMs": 0,
"environmentId": "<string>",
"toolSetupId": "<string>",
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"definitionDigest": "<string>",
"capture": {
"screenshot": "off",
"video": "off",
"trace": "off"
},
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"role": "button",
"name": "<string>"
}
]
}
]
},
"cases": {
"planId": "<string>",
"planDigest": "<string>",
"items": [
{
"ordinal": 5000,
"drillId": "<string>",
"targetId": "<string>",
"classification": "contract",
"trial": 5000,
"trialCount": 5000,
"seed": "<string>",
"timeoutMs": 43200000
}
],
"total": 5000,
"nextAfter": 5000
},
"replayed": true
}{
"plan": {
"schemaVersion": 1,
"planId": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"buildHash": "<string>",
"digest": "<string>",
"concurrency": 32,
"retries": 5,
"logicalCases": 5000,
"maxAttempts": 55000,
"createdBy": "<string>",
"createdAtMs": 0,
"environmentId": "<string>",
"toolSetupId": "<string>",
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"definitionDigest": "<string>",
"capture": {
"screenshot": "off",
"video": "off",
"trace": "off"
},
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"role": "button",
"name": "<string>"
}
]
}
]
},
"cases": {
"planId": "<string>",
"planDigest": "<string>",
"items": [
{
"ordinal": 5000,
"drillId": "<string>",
"targetId": "<string>",
"classification": "contract",
"trial": 5000,
"trialCount": 5000,
"seed": "<string>",
"timeoutMs": 43200000
}
],
"total": 5000,
"nextAfter": 5000
},
"replayed": true
}{
"code": "<string>",
"message": "<string>",
"correlationId": "<string>",
"retryable": true,
"source": "platform",
"retryAfterMs": 123,
"operationId": "<string>",
"issues": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": {},
"evidence": {
"sessionId": "<string>",
"runId": "<string>",
"journalSeq": 4503599627370495,
"buildHash": "<string>"
}
}Preview and retain an exact simulation plan
Select saved drills from one immutable Tool setup. Omitted repetition uses each saved drill’s count. Explicit seeds are exact inputs; repeated seeds remain separate isolated cases. Returns the first paginated case preview. No Tool session or customer agent is started. Reuse the idempotency key and identical request after an interrupted response.
Preview and retain an exact simulation plan
curl --request POST \
--url https://api.firedrill.run/v1/projects/{projectId}/simulation-plans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"drillIds": [
"<string>"
],
"concurrency": 1,
"retries": 0,
"environmentId": "<string>",
"buildHash": "<string>",
"toolSetupId": "<string>",
"seeds": [
"<string>"
],
"repetitions": 5000,
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"name": "<string>"
}
]
}
]
}
'import requests
url = "https://api.firedrill.run/v1/projects/{projectId}/simulation-plans"
payload = {
"drillIds": ["<string>"],
"concurrency": 1,
"retries": 0,
"environmentId": "<string>",
"buildHash": "<string>",
"toolSetupId": "<string>",
"seeds": ["<string>"],
"repetitions": 5000,
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"name": "<string>"
}
]
}
]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
drillIds: ['<string>'],
concurrency: 1,
retries: 0,
environmentId: '<string>',
buildHash: '<string>',
toolSetupId: '<string>',
seeds: ['<string>'],
repetitions: 5000,
browserInvocations: [
{
targetId: '<string>',
testId: '<string>',
expectedTestVersion: 0,
role: {kind: 'tool_ui', packageId: '<string>', instanceId: '<string>'},
mode: 'replay',
timeoutMs: 120000,
maxActions: 100,
captureConsent: 'include-sensitive-content',
captureMask: [{by: 'role', name: '<string>'}]
}
]
})
};
fetch('https://api.firedrill.run/v1/projects/{projectId}/simulation-plans', 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.firedrill.run/v1/projects/{projectId}/simulation-plans",
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([
'drillIds' => [
'<string>'
],
'concurrency' => 1,
'retries' => 0,
'environmentId' => '<string>',
'buildHash' => '<string>',
'toolSetupId' => '<string>',
'seeds' => [
'<string>'
],
'repetitions' => 5000,
'browserInvocations' => [
[
'targetId' => '<string>',
'testId' => '<string>',
'expectedTestVersion' => 0,
'role' => [
'kind' => 'tool_ui',
'packageId' => '<string>',
'instanceId' => '<string>'
],
'mode' => 'replay',
'timeoutMs' => 120000,
'maxActions' => 100,
'captureConsent' => 'include-sensitive-content',
'captureMask' => [
[
'by' => 'role',
'name' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.firedrill.run/v1/projects/{projectId}/simulation-plans"
payload := strings.NewReader("{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.firedrill.run/v1/projects/{projectId}/simulation-plans")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/projects/{projectId}/simulation-plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"drillIds\": [\n \"<string>\"\n ],\n \"concurrency\": 1,\n \"retries\": 0,\n \"environmentId\": \"<string>\",\n \"buildHash\": \"<string>\",\n \"toolSetupId\": \"<string>\",\n \"seeds\": [\n \"<string>\"\n ],\n \"repetitions\": 5000,\n \"browserInvocations\": [\n {\n \"targetId\": \"<string>\",\n \"testId\": \"<string>\",\n \"expectedTestVersion\": 0,\n \"role\": {\n \"kind\": \"tool_ui\",\n \"packageId\": \"<string>\",\n \"instanceId\": \"<string>\"\n },\n \"mode\": \"replay\",\n \"timeoutMs\": 120000,\n \"maxActions\": 100,\n \"captureConsent\": \"include-sensitive-content\",\n \"captureMask\": [\n {\n \"by\": \"role\",\n \"name\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"plan": {
"schemaVersion": 1,
"planId": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"buildHash": "<string>",
"digest": "<string>",
"concurrency": 32,
"retries": 5,
"logicalCases": 5000,
"maxAttempts": 55000,
"createdBy": "<string>",
"createdAtMs": 0,
"environmentId": "<string>",
"toolSetupId": "<string>",
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"definitionDigest": "<string>",
"capture": {
"screenshot": "off",
"video": "off",
"trace": "off"
},
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"role": "button",
"name": "<string>"
}
]
}
]
},
"cases": {
"planId": "<string>",
"planDigest": "<string>",
"items": [
{
"ordinal": 5000,
"drillId": "<string>",
"targetId": "<string>",
"classification": "contract",
"trial": 5000,
"trialCount": 5000,
"seed": "<string>",
"timeoutMs": 43200000
}
],
"total": 5000,
"nextAfter": 5000
},
"replayed": true
}{
"plan": {
"schemaVersion": 1,
"planId": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"buildHash": "<string>",
"digest": "<string>",
"concurrency": 32,
"retries": 5,
"logicalCases": 5000,
"maxAttempts": 55000,
"createdBy": "<string>",
"createdAtMs": 0,
"environmentId": "<string>",
"toolSetupId": "<string>",
"browserInvocations": [
{
"targetId": "<string>",
"testId": "<string>",
"expectedTestVersion": 0,
"role": {
"kind": "tool_ui",
"packageId": "<string>",
"instanceId": "<string>"
},
"mode": "replay",
"timeoutMs": 120000,
"maxActions": 100,
"definitionDigest": "<string>",
"capture": {
"screenshot": "off",
"video": "off",
"trace": "off"
},
"captureConsent": "include-sensitive-content",
"captureMask": [
{
"by": "role",
"role": "button",
"name": "<string>"
}
]
}
]
},
"cases": {
"planId": "<string>",
"planDigest": "<string>",
"items": [
{
"ordinal": 5000,
"drillId": "<string>",
"targetId": "<string>",
"classification": "contract",
"trial": 5000,
"trialCount": 5000,
"seed": "<string>",
"timeoutMs": 43200000
}
],
"total": 5000,
"nextAfter": 5000
},
"replayed": true
}{
"code": "<string>",
"message": "<string>",
"correlationId": "<string>",
"retryable": true,
"source": "platform",
"retryAfterMs": 123,
"operationId": "<string>",
"issues": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": {},
"evidence": {
"sessionId": "<string>",
"runId": "<string>",
"journalSeq": 4503599627370495,
"buildHash": "<string>"
}
}Authorizations
Opaque control credential
Headers
Required string length:
8 - 128Pattern:
^[A-Za-z0-9._:-]+$Path Parameters
Pattern:
^prj_[0-9a-z]{12,32}$Body
application/json
Required array length:
1 - 10000 elementsRequired string length:
1 - 96Pattern:
^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$Required range:
0 < x <= 64Required range:
0 <= x <= 10Pattern:
^env_[0-9a-z]{12,32}$Pattern:
^sha256:[0-9a-f]{64}$Pattern:
^setup_[0-9a-z]{12,32}$Required array length:
1 - 10000 elementsPattern:
^(0|[1-9]\d{0,19})$Required range:
0 < x <= 10000Required array length:
1 - 64 elementsShow child attributes
Show child attributes