Execute Workflow

curl --request POST \
  --url https://api.example.com/v1/workflows/{workflow_uuid}/execute \
  --header 'Content-Type: application/json' \
  --data '
{
  "indicator_type": "<string>",
  "indicator_value": "<string>",
  "alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "confidence": 0.5
}
'

{
  "data": {
    "run_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>"
  },
  "meta": {}
}

Workflows

Execute Workflow

Enqueue a workflow for execution. Returns 202 Accepted immediately. The trigger source is derived from the API key's `key_type` field — agent keys always trigger as "agent", human keys as "human". This cannot be overridden by the request body. Approval gate (based on workflow.approval_mode): - If approval_mode="always": all triggers go through approval gate. - If approval_mode="agent_only": only agent triggers require approval. - If approval_mode="never": no approval required, immediate execution. When the approval gate fires, creates an approval request, enqueues a notification, and returns: {"status": "pending_approval", "approval_request_uuid": "...", "expires_at": "..."} When key_type="agent", both `reason` and `confidence` are required.

POST

workflows

{workflow_uuid}

execute

Execute Workflow

curl --request POST \
  --url https://api.example.com/v1/workflows/{workflow_uuid}/execute \
  --header 'Content-Type: application/json' \
  --data '
{
  "indicator_type": "<string>",
  "indicator_value": "<string>",
  "alert_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "confidence": 0.5
}
'

{
  "data": {
    "run_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>"
  },
  "meta": {}
}

Path Parameters

workflow_uuid

string<uuid>

required

Body

application/json

Request body for POST /v1/workflows/{uuid}/execute.

The trigger source is NOT a request field — it is derived server-side from the API key's key_type (human or agent). Agent keys must also provide reason and confidence for the approval gate.

indicator_type

string

required

indicator_value

string

required

alert_uuid

string<uuid> | null

reason

string | null

confidence

number | null

Required range: 0 <= x <= 1

Response

Successful Response

data

WorkflowExecuteResponse · object

required

Response for POST /v1/workflows/{uuid}/execute (202 Accepted).

Show child attributes

API Reference

Path Parameters

Body

Response