Platform
API Reference
Complete REST API endpoint reference for all platform resources.
Overview
The platform exposes a REST API under /api/v1. All resource endpoints follow standard REST conventions with JSON request and response bodies.
Authentication
Requests are authenticated using JWT tokens, passed either as an HTTP-only cookie or via the Authorization: Bearer {token} header. For webhook triggers and external integrations, API keys are supported through the X-API-Key header.
Available Resources
The API provides endpoints for the following resources:
- Authentication (login, signup, password reset, 2FA)
- Organizations (membership, invitations, switching)
- Schemas (CRUD, data blocks, data points, edges, import/export)
- Processes (CRUD, nodes, edges, versions, locking, import/export)
- Execution (start, stop, test, history, traces, statistics)
- Webhooks (external trigger via API key)
- API Keys (create, list, revoke, rate limits)
- Storage (file upload, download, preview, attachments)
- Dashboards (CRUD, components, database connections)
- Collections (process collections, schema collections)
- Test Cases (create, run, and manage per process)
Full API Documentation
Complete API documentation with endpoint details, request/response schemas, and interactive examples is available in the Orchestrator dashboard under Settings > API Documentation.