Skip to main content
POST
/
v1
/
workflow-definitions
/
{definition_id}
/
invoke
Invoke Workflow Handler
curl --request POST \
  --url http://localhost:8000/v1/workflow-definitions/{definition_id}/invoke \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotency_key": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runner_type": "SELF_HOSTED",
  "status": "PENDING",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "run_snapshot": {
    "workflow_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_name": "<string>",
    "runner_type": "SELF_HOSTED",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "max_run_duration_seconds": 123,
    "sources": [
      {
        "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "materialized_path": "<string>",
        "part_type": "FOLDER"
      }
    ],
    "instructions": [
      {
        "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "materialized_path": "<string>",
        "part_type": "FOLDER"
      }
    ],
    "outputs": [
      {
        "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "materialized_path": "<string>",
        "part_type": "FOLDER"
      }
    ],
    "template": {
      "path_part_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "materialized_path": "<string>",
      "part_type": "FOLDER"
    }
  },
  "error": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.knowledgestack.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null

Path Parameters

​
definition_id
string<uuid>
required

Cookies

​
ks_uat
string | null

Body

application/json

Request body for invoking a workflow definition.

​
idempotency_key
string | null

Optional key to prevent duplicate runs from retries

Maximum string length: 255

Response

Successful Response

Workflow run response.

​
id
string<uuid>
required
​
workflow_definition_id
string<uuid>
required
​
user_id
string<uuid>
required
​
runner_type
enum<string>
required

Runner that executes the workflow.

Available options:
SELF_HOSTED
​
status
enum<string>
required

Lifecycle status of a workflow run.

Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED
​
started_at
string<date-time>
required
​
completed_at
string<date-time> | null
required
​
run_snapshot
WorkflowRunSnapshot · object
required

Frozen ABCD configuration captured at workflow trigger time.

​
error
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required