API Reference

RESTful API endpoints for workflow orchestration

Developer API for Workflow Orchestration

The Lyzr Orchestrator API provides a comprehensive set of RESTful endpoints to programmatically create, manage, execute, and monitor AI-powered workflows. Built on FastAPI with full OpenAPI 3.0 specification, our API enables seamless integration with your applications.

RESTful Design

Standard HTTP methods and status codes

JSON Format

All requests and responses use JSON

Real-time Events

WebSocket support for live updates

Base URL

https://lyzr-d-production.up.railway.app

All API requests should be made to this base URL. Authentication may be required for production deployments.

Workflows API

Create, read, update, and delete workflows. Manage workflow definitions with nodes and edges.

GET/api/workflows

List all workflows with pagination

POST/api/workflows

Create a new workflow definition

GET/api/workflows/:id

Get workflow details by ID

PUT/api/workflows/:id

Update workflow configuration

DELETE/api/workflows/:id

Delete a workflow permanently

Executions API

Trigger workflow runs and monitor execution status in real-time with Temporal orchestration.

POST/api/workflows/:id/execute

Trigger a new workflow execution with input data

GET/api/executions

List all workflow executions with filters

GET/api/executions/:id

Get execution details, status, and outputs

POST/api/executions/:id/cancel

Cancel a running execution

Events API

Stream real-time workflow events, execution logs, and state changes via REST and WebSockets.

GET/api/events

Query historical event logs with pagination

GET/api/workflows/:id/events

Get events for a specific workflow execution

WS/ws/workflows/:id

WebSocket connection for live event streaming

Node Types API

Discover available node types, their configuration schemas, and input/output specifications.

GET/api/node-types

List all available node types and categories

GET/api/node-types/:type

Get detailed schema for a specific node type

GET/api/node-types/:type/schema

Get JSON Schema for node configuration validation

Authentication & Usage

Request Headers

Content-Type: application/json

Accept: application/json

Response Format

All responses return JSON with standard structure:

{ "data": {...}, "status": "success" }

Example: Execute a Workflow

curl -X POST "https://lyzr-d-production.up.railway.app/api/workflows/abc123/execute" \
  -H "Content-Type: application/json" \
  -d '{
    "input_data": {
      "user_query": "Analyze customer sentiment",
      "data_source": "reviews.csv"
    }
  }'

Interactive API Documentation

For detailed API documentation with interactive examples, request/response schemas, and a built-in API testing interface, visit our Swagger UI:

Open Interactive API Documentation