OpenAPI Specification
FlowDrop publishes an OpenAPI 3.0 specification that documents every REST endpoint the editor can call. This is the authoritative API contract for building a compatible backend.
View the Specification
Section titled “View the Specification”The interactive API documentation is available at:
This Redocly-powered site lets you browse all endpoints, see request/response schemas, and try example payloads.
Using the Spec
Section titled “Using the Spec”For Backend Development
Section titled “For Backend Development”Use the OpenAPI spec to:
- Generate server stubs with tools like openapi-generator or swagger-codegen
- Validate your API against the spec using tools like Prism
- Auto-generate documentation for your specific backend implementation
For Client Development
Section titled “For Client Development”The spec can also generate typed API clients:
# Generate TypeScript clientnpx openapi-generator-cli generate -i openapi.yaml -g typescript-fetch -o ./generatedEndpoint Groups
Section titled “Endpoint Groups”The spec covers all endpoint groups documented in the API Overview:
- Health & System — Health check, runtime config
- Nodes — Node type discovery and metadata
- Categories — Node category definitions
- Port Config — Data types and compatibility rules
- Workflows — CRUD operations, validation, import/export
- Execution — Workflow execution and status
- Pipelines — Pipeline management
- Playground — Interactive testing sessions and messages
- Interrupts — Human-in-the-loop management
- Settings — User preferences
- Agent Spec — Agent Spec format operations
Next Steps
Section titled “Next Steps”- Backend Implementation — build your backend using this spec
- Backend: Express.js — working reference implementation
- API Overview — module structure and endpoint summary