Skip to main content
PATCH
/
v1
/
runs
/
{run_id}
Update Run
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/runs/{run_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "error": [
    "<string>"
  ],
  "output_data": {},
  "output_attachment_ids": [
    "<string>"
  ],
  "run_message_history": [
    {}
  ],
  "input_values": {},
  "usage_metadata": {},
  "post_run_checks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "post_run_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "snapshot_version": 123,
      "name": "<string>",
      "description": "<string>",
      "order": 123,
      "file_names": [
        "<string>"
      ],
      "file_name_regex": "<string>",
      "expected_match_count": 123,
      "expected_match_count_ref": "<string>",
      "loop_input": "<string>",
      "loop_item_filename_template": "<string>",
      "allow_missing_attachments": false,
      "check_prompt": "<string>",
      "model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "messages": [
        "<string>"
      ],
      "matched_filenames": [
        "<string>"
      ]
    }
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "release_session_after": true
}
'
import requests

url = "https://api.cyberdesk.io/v1/runs/{run_id}"

payload = {
    "error": ["<string>"],
    "output_data": {},
    "output_attachment_ids": ["<string>"],
    "run_message_history": [{}],
    "input_values": {},
    "usage_metadata": {},
    "post_run_checks": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "post_run_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "snapshot_version": 123,
            "name": "<string>",
            "description": "<string>",
            "order": 123,
            "file_names": ["<string>"],
            "file_name_regex": "<string>",
            "expected_match_count": 123,
            "expected_match_count_ref": "<string>",
            "loop_input": "<string>",
            "loop_item_filename_template": "<string>",
            "allow_missing_attachments": False,
            "check_prompt": "<string>",
            "model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "started_at": "2023-11-07T05:31:56Z",
            "ended_at": "2023-11-07T05:31:56Z",
            "error_message": "<string>",
            "messages": ["<string>"],
            "matched_filenames": ["<string>"]
        }
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "release_session_after": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    error: ['<string>'],
    output_data: {},
    output_attachment_ids: ['<string>'],
    run_message_history: [{}],
    input_values: {},
    usage_metadata: {},
    post_run_checks: [
      {
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        post_run_check_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        snapshot_version: 123,
        name: '<string>',
        description: '<string>',
        order: 123,
        file_names: ['<string>'],
        file_name_regex: '<string>',
        expected_match_count: 123,
        expected_match_count_ref: '<string>',
        loop_input: '<string>',
        loop_item_filename_template: '<string>',
        allow_missing_attachments: false,
        check_prompt: '<string>',
        model: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        started_at: '2023-11-07T05:31:56Z',
        ended_at: '2023-11-07T05:31:56Z',
        error_message: '<string>',
        messages: ['<string>'],
        matched_filenames: ['<string>']
      }
    ],
    started_at: '2023-11-07T05:31:56Z',
    ended_at: '2023-11-07T05:31:56Z',
    release_session_after: true
  })
};

fetch('https://api.cyberdesk.io/v1/runs/{run_id}', 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/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'error' => [
        '<string>'
    ],
    'output_data' => [
        
    ],
    'output_attachment_ids' => [
        '<string>'
    ],
    'run_message_history' => [
        [
                
        ]
    ],
    'input_values' => [
        
    ],
    'usage_metadata' => [
        
    ],
    'post_run_checks' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'post_run_check_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'snapshot_version' => 123,
                'name' => '<string>',
                'description' => '<string>',
                'order' => 123,
                'file_names' => [
                                '<string>'
                ],
                'file_name_regex' => '<string>',
                'expected_match_count' => 123,
                'expected_match_count_ref' => '<string>',
                'loop_input' => '<string>',
                'loop_item_filename_template' => '<string>',
                'allow_missing_attachments' => false,
                'check_prompt' => '<string>',
                'model' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'started_at' => '2023-11-07T05:31:56Z',
                'ended_at' => '2023-11-07T05:31:56Z',
                'error_message' => '<string>',
                'messages' => [
                                '<string>'
                ],
                'matched_filenames' => [
                                '<string>'
                ]
        ]
    ],
    'started_at' => '2023-11-07T05:31:56Z',
    'ended_at' => '2023-11-07T05:31:56Z',
    'release_session_after' => true
  ]),
  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/{run_id}"

	payload := strings.NewReader("{\n  \"error\": [\n    \"<string>\"\n  ],\n  \"output_data\": {},\n  \"output_attachment_ids\": [\n    \"<string>\"\n  ],\n  \"run_message_history\": [\n    {}\n  ],\n  \"input_values\": {},\n  \"usage_metadata\": {},\n  \"post_run_checks\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"post_run_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"snapshot_version\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"order\": 123,\n      \"file_names\": [\n        \"<string>\"\n      ],\n      \"file_name_regex\": \"<string>\",\n      \"expected_match_count\": 123,\n      \"expected_match_count_ref\": \"<string>\",\n      \"loop_input\": \"<string>\",\n      \"loop_item_filename_template\": \"<string>\",\n      \"allow_missing_attachments\": false,\n      \"check_prompt\": \"<string>\",\n      \"model\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"started_at\": \"2023-11-07T05:31:56Z\",\n      \"ended_at\": \"2023-11-07T05:31:56Z\",\n      \"error_message\": \"<string>\",\n      \"messages\": [\n        \"<string>\"\n      ],\n      \"matched_filenames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\",\n  \"release_session_after\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cyberdesk.io/v1/runs/{run_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"error\": [\n    \"<string>\"\n  ],\n  \"output_data\": {},\n  \"output_attachment_ids\": [\n    \"<string>\"\n  ],\n  \"run_message_history\": [\n    {}\n  ],\n  \"input_values\": {},\n  \"usage_metadata\": {},\n  \"post_run_checks\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"post_run_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"snapshot_version\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"order\": 123,\n      \"file_names\": [\n        \"<string>\"\n      ],\n      \"file_name_regex\": \"<string>\",\n      \"expected_match_count\": 123,\n      \"expected_match_count_ref\": \"<string>\",\n      \"loop_input\": \"<string>\",\n      \"loop_item_filename_template\": \"<string>\",\n      \"allow_missing_attachments\": false,\n      \"check_prompt\": \"<string>\",\n      \"model\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"started_at\": \"2023-11-07T05:31:56Z\",\n      \"ended_at\": \"2023-11-07T05:31:56Z\",\n      \"error_message\": \"<string>\",\n      \"messages\": [\n        \"<string>\"\n      ],\n      \"matched_filenames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\",\n  \"release_session_after\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.cyberdesk.io/v1/runs/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"error\": [\n    \"<string>\"\n  ],\n  \"output_data\": {},\n  \"output_attachment_ids\": [\n    \"<string>\"\n  ],\n  \"run_message_history\": [\n    {}\n  ],\n  \"input_values\": {},\n  \"usage_metadata\": {},\n  \"post_run_checks\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"post_run_check_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"snapshot_version\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"order\": 123,\n      \"file_names\": [\n        \"<string>\"\n      ],\n      \"file_name_regex\": \"<string>\",\n      \"expected_match_count\": 123,\n      \"expected_match_count_ref\": \"<string>\",\n      \"loop_input\": \"<string>\",\n      \"loop_item_filename_template\": \"<string>\",\n      \"allow_missing_attachments\": false,\n      \"check_prompt\": \"<string>\",\n      \"model\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"started_at\": \"2023-11-07T05:31:56Z\",\n      \"ended_at\": \"2023-11-07T05:31:56Z\",\n      \"error_message\": \"<string>\",\n      \"messages\": [\n        \"<string>\"\n      ],\n      \"matched_filenames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"started_at\": \"2023-11-07T05:31:56Z\",\n  \"ended_at\": \"2023-11-07T05:31:56Z\",\n  \"release_session_after\": true\n}"

response = http.request(request)
puts response.read_body
{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "error": [
    "<string>"
  ],
  "output_data": {},
  "input_attachment_ids": [
    "<string>"
  ],
  "output_attachment_ids": [
    "<string>"
  ],
  "run_message_history": [
    {}
  ],
  "input_values": {},
  "main_prompt": "<string>",
  "model_metadata": {
    "main_agent_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cache_detection_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fallback_model_1_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fallback_model_2_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sensitive_input_aliases": {},
  "usage_metadata": {},
  "post_run_checks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "post_run_check_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "snapshot_version": 123,
      "name": "<string>",
      "description": "<string>",
      "order": 123,
      "file_names": [
        "<string>"
      ],
      "file_name_regex": "<string>",
      "expected_match_count": 123,
      "expected_match_count_ref": "<string>",
      "loop_input": "<string>",
      "loop_item_filename_template": "<string>",
      "allow_missing_attachments": false,
      "check_prompt": "<string>",
      "model": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "error_message": "<string>",
      "messages": [
        "<string>"
      ],
      "matched_filenames": [
        "<string>"
      ]
    }
  ],
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_alias": "<string>",
  "release_session_after": true,
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z"
}
{
  "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"

Path Parameters

​
run_id
string<uuid>
required

Body

application/json

Schema for updating a run

​
status
enum<string> | null
Available options:
scheduling,
running,
running_checks,
success,
cancelled,
task_failed,
error
​
error
string[] | null
​
output_data
Output Data · object | null
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
Input Values · object | null
​
usage_metadata
Usage Metadata · object | null
​
post_run_checks
RunPostRunCheckSnapshot · object[] | null
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null
​
release_session_after
boolean | null

Response

Successful Response

Run response schema

​
workflow_id
string<uuid>
required
​
machine_id
string<uuid> | null
required
​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
scheduling,
running,
running_checks,
success,
cancelled,
task_failed,
error
​
created_at
string<date-time>
required
​
user_id
string<uuid> | null
​
organization_id
string | null
​
error
string[] | null
​
output_data
Output Data · object | null
​
input_attachment_ids
string[] | null
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
Input Values · object | null
​
main_prompt
string | null

Per-run prompt override used for execution. Null means the run falls back to the workflow's current main_prompt.

​
model_metadata
WorkflowModelMetadata · object | null

Per-run model metadata overrides used for execution. Null means the run falls back to the workflow's model_metadata.

​
pool_ids
string<uuid>[] | null
​
sensitive_input_aliases
Sensitive Input Aliases · object | null
​
usage_metadata
Usage Metadata · object | null

Arbitrary usage/billing metadata captured during a run (schema is flexible)

​
post_run_checks
RunPostRunCheckSnapshot · object[] | null

Version-tolerant snapshot/results for the run's post-run checks.

​
session_id
string<uuid> | null
​
session_alias
string | null
​
release_session_after
boolean | null
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null