Create Async Run - Noxus Documentation

Create Run With Api Key

curl --request POST \
  --url https://api.example.com/v1/workflows/{workflow_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": {},
  "node_ids": [
    "<string>"
  ],
  "single_node_id": "<string>",
  "group_id": "<string>",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tracing": false,
  "debugger": "<string>",
  "callback_url": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "input": {},
  "output": {},
  "node_ids": [
    "<string>"
  ],
  "single_node_id": "<string>",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "progress_details": {
    "executed_nodes": [
      "<string>"
    ],
    "remaining_nodes": [
      "<string>"
    ],
    "per_node_progress": {},
    "running_nodes": [
      "<string>"
    ],
    "skipped_nodes": [],
    "error_handler_nodes": [],
    "subflow_executions": {},
    "per_edge_progress": {},
    "run_logs": {}
  },
  "progress": 0,
  "finished_at": "2023-11-07T05:31:56Z"
}

POST

workflows

{workflow_id}

runs

Create Run With Api Key

curl --request POST \
  --url https://api.example.com/v1/workflows/{workflow_id}/runs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": {},
  "node_ids": [
    "<string>"
  ],
  "single_node_id": "<string>",
  "group_id": "<string>",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tracing": false,
  "debugger": "<string>",
  "callback_url": "<string>"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "input": {},
  "output": {},
  "node_ids": [
    "<string>"
  ],
  "single_node_id": "<string>",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "progress_details": {
    "executed_nodes": [
      "<string>"
    ],
    "remaining_nodes": [
      "<string>"
    ],
    "per_node_progress": {},
    "running_nodes": [
      "<string>"
    ],
    "skipped_nodes": [],
    "error_handler_nodes": [],
    "subflow_executions": {},
    "per_edge_progress": {},
    "run_logs": {}
  },
  "progress": 0,
  "finished_at": "2023-11-07T05:31:56Z"
}

Parameters

Path Parameters

workflow_id

string

required

The ID of the workflow to run.

Body Parameters

input

object

required

Key-value pairs mapping input node labels (or IDs) to their values. The keys depend on how your workflow’s input nodes are configured.

{
  "User Question": "What is machine learning?",
  "Context": "Explain for a beginner"
}

callback_url

string

Optional webhook URL. When the run reaches a terminal state (completed, failed, or stopped), the platform sends a POST request to this URL with the run result. Must be a valid HTTP(S) URL — invalid URLs are rejected with a 422 at creation time.

Show Webhook payload

Your endpoint receives a POST with Content-Type: application/json and the following body:

Field	Type	Description
`run_id`	`string`	The unique ID of the run
`workflow_id`	`string`	The workflow that was executed
`status`	`string`	Terminal status: `completed`, `failed`, or `stopped`
`outputs`	`object \| null`	The run’s output data (same structure as the GET run response)
`error`	`string \| null`	Error message if the run failed, `null` otherwise
`started_at`	`string \| null`	ISO 8601 timestamp when execution started
`completed_at`	`string \| null`	ISO 8601 timestamp when execution finished
`duration_ms`	`integer \| null`	Total execution time in milliseconds

Example payload:

{
  "run_id": "8e9e0b2d-768b-4697-ac0e-186f7b887b51",
  "workflow_id": "2d0a6b8e-7144-468d-acfd-c812cb4b4953",
  "status": "completed",
  "outputs": {
    "node-id::output": {
      "text": "The generated result...",
      "file": null
    }
  },
  "error": null,
  "started_at": "2025-06-15T10:30:00.000000",
  "completed_at": "2025-06-15T10:30:05.123456",
  "duration_ms": 5123
}

Show Delivery behavior

Retries: If your endpoint returns a non-2xx status or is unreachable, delivery is retried up to 3 times with exponential backoff (1s, 5s, 15s delays between attempts).
Timeout: Each delivery attempt times out after 10 seconds.
Non-blocking: Webhook delivery never affects run execution. If all retries fail, the run still completes normally — the webhook is simply not delivered.
Fire-on-terminal: Webhooks fire on all terminal states: completed, failed, and stopped (via the stop API).
Your endpoint should return a 2xx status code to acknowledge receipt.

workflow_version_id

string (uuid)

Run a specific saved version of the workflow. If omitted, the latest (current) version is used.

node_ids

string[]

Limit execution to a subset of node IDs. Only these nodes (and their dependencies) will run. If omitted, the full workflow runs.

single_node_id

string

Run a single node in isolation. The provided input must satisfy all of the node’s input requirements.

tracing

boolean

default:"false"

Enable OpenTelemetry tracing for this run. Traces are sent to your configured observability provider.

group_id

string

Override the workspace (group) for this run. Defaults to the workspace associated with the API key.

debugger

string

Debugger session ID for live debugging in the workflow editor.

Examples

Basic run

curl -X POST https://backend.noxus.ai/v1/workflows/{workflow_id}/runs \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "User Question": "What are the benefits of renewable energy?"
    }
  }'

Run with webhook callback

curl -X POST https://backend.noxus.ai/v1/workflows/{workflow_id}/runs \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "User Question": "Summarize this document"
    },
    "callback_url": "https://your-server.com/webhook/noxus"
  }'

Your webhook endpoint will receive a POST with:

{
  "run_id": "abc-123",
  "workflow_id": "wf-456",
  "status": "completed",
  "outputs": { ... },
  "error": null,
  "started_at": "2025-01-15T10:30:00.000000",
  "completed_at": "2025-01-15T10:30:05.000000",
  "duration_ms": 5000
}

Run a specific version

curl -X POST https://backend.noxus.ai/v1/workflows/{workflow_id}/runs \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {"Query": "Hello"},
    "workflow_version_id": "version-uuid-here"
  }'

Authorizations

X-API-Key

string

header

required

Path Parameters

workflow_id

string

required

Body

application/json

input

Input · object

required

node_ids

string[] | null

single_node_id

string | null

group_id

string | null

workflow_version_id

string<uuid> | null

tracing

boolean

default:false

debugger

string | null

callback_url

string<uri> | null

Required string length: 1 - 2083

Response

Successful Response

SimplifiedRun for public API — excludes workflow_definition.

string<uuid>

required

group_id

string<uuid>

required

workflow_id

string<uuid>

required

status

enum<string>

required

Available options:

queued,

running,

failed,

completed,

stopped,

awaiting_human_feedback

created_at

string<date-time>

required

input

Input · object

output

Output · object

node_ids

single_node_id

string | null

workflow_version_id

string<uuid> | null

progress_details

WorkflowProgress · object

Show child attributes

progress

integer

default:0

finished_at

string<date-time> | null

Create Sync Run Stream Run Events

⌘I

​Parameters

​Path Parameters

​Body Parameters

​Examples

​Basic run

​Run with webhook callback

​Run a specific version

Authorizations

Path Parameters

Body

Response

Parameters

Path Parameters

Body Parameters

Examples

Basic run

Run with webhook callback

Run a specific version