Skip to main content
POST
/
v1
/
runs
/
{run_id}
/
retry
Retry Run
curl --request POST \
  --url https://api.cyberdesk.io/v1/runs/{run_id}/retry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_values": {},
  "sensitive_input_values": {},
  "file_inputs": [
    {
      "filename": "<string>",
      "content": "<string>",
      "target_path": "<string>",
      "cleanup_imports_after_run": false
    }
  ],
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "reuse_session": true,
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_session": false,
  "session_alias": "<string>",
  "release_session_after": true
}
'
{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "scheduling",
  "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": {},
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sensitive_input_aliases": {},
  "usage_metadata": {},
  "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"
}

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

Options for retrying an existing run in-place (same run_id).

Notes:

  • If file_inputs are provided, existing input attachments are replaced.
  • Prior outputs, history, and output attachments are always cleared as part of retry.
  • Retry is only allowed for terminal runs (success, task_failed, error, or cancelled).
​
input_values
Input Values · object

Override input values for workflow variables

​
sensitive_input_values
Sensitive Input Values · object

Provide new sensitive inputs (supports nested objects); stored in vault and mapped to aliases

​
file_inputs
FileInput · object[] | null

Provide new input files for this retry; replaces existing input attachments

​
machine_id
string<uuid> | null

Override specific machine for this retry

​
pool_ids
string<uuid>[] | null

Override pool filters if not using a specific machine

​
reuse_session
boolean | null
default:true

Keep existing session_id. If false and no session_id provided, clears session fields

​
session_id
string<uuid> | null

Set/override session_id for this retry

​
start_session
boolean | null
default:false

Start a fresh new session for this retry (creates new session_id)

​
session_alias
string | null

Set/override session_alias for this retry (used with start_session or session_id)

​
release_session_after
boolean | null

Override release_session_after behavior for this retry

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,
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
​
input_attachment_ids
string[] | null
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
Input Values · object
​
pool_ids
string<uuid>[] | null
​
sensitive_input_aliases
Sensitive Input Aliases · object
​
usage_metadata
Usage Metadata · object

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

​
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