Base URL
All API requests should be made to:Official SDKs
Use our official SDKs instead of raw HTTP requests:Authentication
Protected endpoints require a Bearer token in the Authorization header:API tokens require a minimum $2.00 account balance to create. Tokens can be configured with custom expiry (default: 1 hour, max: 1 year).
Endpoints
The Splox API provides these endpoints:Workflows
Workflow Execution
Chats
Events
Billing
Typical API Flow
1
Discover Your Workflow
GET /workflows — List your workflows (or search by name). Then get the latest version with GET /workflows/{id}/versions/latest and its entry nodes with GET /workflows/{versionId}/entry-nodes.2
Create a Chat
POST /chats — Create a chat session for the workflow. The chat ID is used for context memory and SSE streaming.3
Run the Workflow
POST /workflow-requests/run — Trigger the workflow with your query, chat ID, workflow version ID, and entry node IDs. Returns a workflow_request_id.4
Listen for Results
GET /workflow-requests/{id}/listen — Connect to the SSE stream to receive real-time execution updates as nodes complete.Response Format
All responses return JSON. Example run workflow response:SSE Streaming
SSE endpoints (/listen) use standard Server-Sent Events format:
- Keepalive messages sent every 3 seconds
- Connection timeout: 30 minutes (reconnect if needed)
Rate Limits
Support
- Community: community.splox.io
- Email: [email protected]