Skip to main content
POST
/
v1
/
runs
/
chain
Create Run Chain
curl --request POST \
  --url https://api.cyberdesk.io/v1/runs/chain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "steps": [
    {
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_alias": "<string>",
      "inputs": {},
      "sensitive_inputs": {}
    }
  ],
  "shared_inputs": {},
  "shared_sensitive_inputs": {},
  "shared_file_inputs": [
    {
      "filename": "<string>",
      "content": "<string>",
      "target_path": "<string>",
      "cleanup_imports_after_run": false
    }
  ],
  "keep_session_after_completion": false,
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

url = "https://api.cyberdesk.io/v1/runs/chain"

payload = {
    "steps": [
        {
            "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "session_alias": "<string>",
            "inputs": {},
            "sensitive_inputs": {}
        }
    ],
    "shared_inputs": {},
    "shared_sensitive_inputs": {},
    "shared_file_inputs": [
        {
            "filename": "<string>",
            "content": "<string>",
            "target_path": "<string>",
            "cleanup_imports_after_run": False
        }
    ],
    "keep_session_after_completion": False,
    "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pool_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    steps: [
      {
        workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        session_alias: '<string>',
        inputs: {},
        sensitive_inputs: {}
      }
    ],
    shared_inputs: {},
    shared_sensitive_inputs: {},
    shared_file_inputs: [
      {
        filename: '<string>',
        content: '<string>',
        target_path: '<string>',
        cleanup_imports_after_run: false
      }
    ],
    keep_session_after_completion: false,
    machine_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    pool_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.cyberdesk.io/v1/runs/chain', 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.cyberdesk.io/v1/runs/chain",
  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([
    'steps' => [
        [
                'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'session_alias' => '<string>',
                'inputs' => [
                                
                ],
                'sensitive_inputs' => [
                                
                ]
        ]
    ],
    'shared_inputs' => [
        
    ],
    'shared_sensitive_inputs' => [
        
    ],
    'shared_file_inputs' => [
        [
                'filename' => '<string>',
                'content' => '<string>',
                'target_path' => '<string>',
                'cleanup_imports_after_run' => false
        ]
    ],
    'keep_session_after_completion' => false,
    'machine_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'pool_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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.cyberdesk.io/v1/runs/chain"

	payload := strings.NewReader("{\n  \"steps\": [\n    {\n      \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"session_alias\": \"<string>\",\n      \"inputs\": {},\n      \"sensitive_inputs\": {}\n    }\n  ],\n  \"shared_inputs\": {},\n  \"shared_sensitive_inputs\": {},\n  \"shared_file_inputs\": [\n    {\n      \"filename\": \"<string>\",\n      \"content\": \"<string>\",\n      \"target_path\": \"<string>\",\n      \"cleanup_imports_after_run\": false\n    }\n  ],\n  \"keep_session_after_completion\": false,\n  \"machine_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pool_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.cyberdesk.io/v1/runs/chain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"steps\": [\n    {\n      \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"session_alias\": \"<string>\",\n      \"inputs\": {},\n      \"sensitive_inputs\": {}\n    }\n  ],\n  \"shared_inputs\": {},\n  \"shared_sensitive_inputs\": {},\n  \"shared_file_inputs\": [\n    {\n      \"filename\": \"<string>\",\n      \"content\": \"<string>\",\n      \"target_path\": \"<string>\",\n      \"cleanup_imports_after_run\": false\n    }\n  ],\n  \"keep_session_after_completion\": false,\n  \"machine_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pool_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cyberdesk.io/v1/runs/chain")

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  \"steps\": [\n    {\n      \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"session_alias\": \"<string>\",\n      \"inputs\": {},\n      \"sensitive_inputs\": {}\n    }\n  ],\n  \"shared_inputs\": {},\n  \"shared_sensitive_inputs\": {},\n  \"shared_file_inputs\": [\n    {\n      \"filename\": \"<string>\",\n      \"content\": \"<string>\",\n      \"target_path\": \"<string>\",\n      \"cleanup_imports_after_run\": false\n    }\n  ],\n  \"keep_session_after_completion\": false,\n  \"machine_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"pool_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Request to create and run a multi-step chain on a single reserved session/machine

​
steps
ChainStep · object[]
required
Minimum array length: 1
​
shared_inputs
Shared Inputs · object | null
​
shared_sensitive_inputs
Shared Sensitive Inputs · object | null

Shared sensitive inputs (supports nested objects) for all steps

​
shared_file_inputs
FileInput · object[] | null
​
keep_session_after_completion
boolean | null
default:false
​
machine_id
string<uuid> | null
​
pool_ids
string<uuid>[] | null

Pool IDs to filter available machines when starting a new session. Machine must belong to ALL of these pools (intersection). Ignored when machine_id is provided.

​
session_id
string<uuid> | null

Response

Returns persisted run_ids for the created chain session. If Temporal dispatch fails after run persistence, this endpoint still returns 201 with run_ids; those runs are marked ERROR and include failure details in subsequent run reads.

Response for chain creation

​
session_id
string<uuid>
required
​
run_ids
string<uuid>[]
required