Create a Tool instance
curl --request POST \
--url https://api.firedrill.run/v1/service-instances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"seed": "<string>",
"actorOperations": [
"<string>"
],
"datasetId": "<string>",
"ttlSeconds": 4503599627370496
}
'import requests
url = "https://api.firedrill.run/v1/service-instances"
payload = {
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"seed": "<string>",
"actorOperations": ["<string>"],
"datasetId": "<string>",
"ttlSeconds": 4503599627370496
}
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({
projectId: '<string>',
environmentId: '<string>',
buildId: '<string>',
seed: '<string>',
actorOperations: ['<string>'],
datasetId: '<string>',
ttlSeconds: 4503599627370496
})
};
fetch('https://api.firedrill.run/v1/service-instances', 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/service-instances",
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([
'projectId' => '<string>',
'environmentId' => '<string>',
'buildId' => '<string>',
'seed' => '<string>',
'actorOperations' => [
'<string>'
],
'datasetId' => '<string>',
'ttlSeconds' => 4503599627370496
]),
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/service-instances"
payload := strings.NewReader("{\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\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/service-instances")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/service-instances")
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 \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"datasetId": "<string>",
"epoch": 123,
"status": "<string>",
"createdAt": "<string>",
"expiresAt": "<string>",
"finishedAt": "<string>",
"seed": "<string>",
"actorOperations": [
"<string>"
],
"runtime": "<unknown>",
"invocationPolicy": "creating_credential_only",
"service": {
"id": "<string>",
"version": "<string>",
"name": null,
"httpRoutes": [
{
"method": "<string>",
"path": "<string>",
"operationId": "<string>"
}
],
"view": {
"declared": true,
"available": true,
"title": "<string>",
"operationIds": [
"<string>"
],
"readOnly": false
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}Create a Tool instance
Requires services:create. Uses an exact build, explicit decimal seed, optional dataset and actor operation allowlist. New independent instances receive isolated state. Empty or omitted data is not replaced by a sample dataset.
Create a Tool instance
curl --request POST \
--url https://api.firedrill.run/v1/service-instances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"seed": "<string>",
"actorOperations": [
"<string>"
],
"datasetId": "<string>",
"ttlSeconds": 4503599627370496
}
'import requests
url = "https://api.firedrill.run/v1/service-instances"
payload = {
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"seed": "<string>",
"actorOperations": ["<string>"],
"datasetId": "<string>",
"ttlSeconds": 4503599627370496
}
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({
projectId: '<string>',
environmentId: '<string>',
buildId: '<string>',
seed: '<string>',
actorOperations: ['<string>'],
datasetId: '<string>',
ttlSeconds: 4503599627370496
})
};
fetch('https://api.firedrill.run/v1/service-instances', 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/service-instances",
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([
'projectId' => '<string>',
'environmentId' => '<string>',
'buildId' => '<string>',
'seed' => '<string>',
'actorOperations' => [
'<string>'
],
'datasetId' => '<string>',
'ttlSeconds' => 4503599627370496
]),
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/service-instances"
payload := strings.NewReader("{\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\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/service-instances")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.firedrill.run/v1/service-instances")
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 \"projectId\": \"<string>\",\n \"environmentId\": \"<string>\",\n \"buildId\": \"<string>\",\n \"seed\": \"<string>\",\n \"actorOperations\": [\n \"<string>\"\n ],\n \"datasetId\": \"<string>\",\n \"ttlSeconds\": 4503599627370496\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"projectId": "<string>",
"environmentId": "<string>",
"buildId": "<string>",
"datasetId": "<string>",
"epoch": 123,
"status": "<string>",
"createdAt": "<string>",
"expiresAt": "<string>",
"finishedAt": "<string>",
"seed": "<string>",
"actorOperations": [
"<string>"
],
"runtime": "<unknown>",
"invocationPolicy": "creating_credential_only",
"service": {
"id": "<string>",
"version": "<string>",
"name": null,
"httpRoutes": [
{
"method": "<string>",
"path": "<string>",
"operationId": "<string>"
}
],
"view": {
"declared": true,
"available": true,
"title": "<string>",
"operationIds": [
"<string>"
],
"readOnly": false
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"repair": "<string>",
"requestId": "<string>",
"details": "<string>",
"validation": {
"issues": [
{
"path": [
"<string>"
],
"code": "<string>",
"message": "<string>",
"pathTruncated": true
}
],
"totalIssues": 123,
"omittedIssues": 123
}
}
}Authorizations
Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.
Headers
Save a unique stable key for this exact logical action, at most 200 characters. Reuse it with identical input after an uncertain response. A new key is new intent; it must not be used merely to recover an accepted action.
Required string length:
1 - 200Body
application/json
Required string length:
1 - 160Required string length:
1 - 160Required string length:
1 - 160Pattern:
^(0|[1-9][0-9]*)$Required array length:
1 - 256 elementsRequired string length:
1 - 160Required string length:
1 - 160Required range:
1 <= x <= 9007199254740991Response
The retained resource or operation response.
Any JSON value: null, boolean, finite number, string, array or object. The request transport must contain valid JSON; canonical validation rejects nonfinite numbers.
Available options:
creating_credential_only, creating_member_or_credential_only, current_run_connection_only Show child attributes
Show child attributes