Nodes¶

Node CRUD endpoints for managing workflow nodes. Nodes are nested under their parent workflow.

All endpoints are under /api/v1/workflows/{slug}/nodes/ and require Bearer token authentication.

GET /api/v1/workflows/{slug}/nodes/¶

List all nodes in a workflow.

Path parameters:

Example request:

curl http://localhost:8000/api/v1/workflows/my-chatbot/nodes/ \
  -H "Authorization: Bearer <api_key>"

Response (200):

[
  {
    "id": 1,
    "node_id": "trigger_chat_a1b2c3",
    "component_type": "trigger_chat",
    "is_entry_point": false,
    "interrupt_before": false,
    "interrupt_after": false,
    "position_x": 100,
    "position_y": 200,
    "config": {
      "system_prompt": "",
      "extra_config": {},
      "llm_credential_id": null,
      "model_name": "",
      "temperature": null,
      "max_tokens": null,
      "frequency_penalty": null,
      "presence_penalty": null,
      "top_p": null,
      "timeout": null,
      "max_retries": null,
      "response_format": null,
      "llm_model_config_id": null,
      "credential_id": null,
      "is_active": true,
      "priority": 0,
      "trigger_config": {}
    },
    "subworkflow_id": null,
    "code_block_id": null,
    "updated_at": "2025-01-15T10:30:00",
    "schedule_job": null
  }
]

POST /api/v1/workflows/{slug}/nodes/¶

Create a new node in a workflow.

Path parameters:

Request body:

Config object fields:

Example request:

curl -X POST http://localhost:8000/api/v1/workflows/my-chatbot/nodes/ \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "node_id": "agent_abc123",
    "component_type": "agent",
    "position_x": 400,
    "position_y": 200,
    "config": {
      "system_prompt": "You are a helpful assistant."
    }
  }'

Response (201): Node object (same format as list response items).

Broadcasts a node_created WebSocket event on the workflow:<slug> channel.

PATCH /api/v1/workflows/{slug}/nodes/{node_id}/¶

Update an existing node's configuration or position.

Path parameters:

Request body (all fields optional):

Same fields as create, but all are optional. Only include the fields you want to update.

Example request:

curl -X PATCH http://localhost:8000/api/v1/workflows/my-chatbot/nodes/agent_abc123/ \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "position_x": 500,
    "config": {
      "system_prompt": "You are a customer support agent."
    }
  }'

Response (200): Updated node object.

Broadcasts a node_updated WebSocket event on the workflow:<slug> channel.

Error (404): "Node not found."

DELETE /api/v1/workflows/{slug}/nodes/{node_id}/¶

Delete a node and all its connected edges. If the node is a trigger_schedule, any associated scheduled job is also cleaned up.

Path parameters:

Example request:

curl -X DELETE http://localhost:8000/api/v1/workflows/my-chatbot/nodes/agent_abc123/ \
  -H "Authorization: Bearer <api_key>"

Response (204): No content.

Broadcasts a node_deleted WebSocket event on the workflow:<slug> channel.

Error (404): "Node not found."

Schedule Actions¶

These endpoints manage the scheduled execution of trigger_schedule nodes.

POST /api/v1/workflows/{slug}/nodes/{node_id}/schedule/start¶

Start or restart a scheduled job for a trigger_schedule node. Configuration is read from the node's extra_config.

Extra config fields:

Response (200): Updated node object.

Error (400): "Node is not a trigger_schedule."

POST /api/v1/workflows/{slug}/nodes/{node_id}/schedule/pause¶

Pause an active scheduled job.

Response (200): Updated node object.

Error (400): "Cannot pause job with status 'paused'."

POST /api/v1/workflows/{slug}/nodes/{node_id}/schedule/stop¶

Stop and remove a scheduled job.

Response (200): Updated node object.

Component Types¶

The following component types are available: