Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.splox.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

All API requests should be made to: 
https://app.splox.io/api/v1

​
Official SDKs

Use our official SDKs instead of raw HTTP requests: 
pip install splox
See the full SDK documentation for quickstart examples, authentication, error handling, and more.

​
Authentication

Protected endpoints require a Bearer token in the Authorization header: 
Authorization: Bearer YOUR_API_TOKEN
Generate API tokens from your account settings.
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

MethodEndpointDescription
GET/workflowsList all workflows
GET/workflows/{id}Get a workflow with nodes and edges
GET/workflows/{id}/versions/latestGet the latest workflow version
GET/workflows/{id}/versionsList all workflow versions
GET/workflows/{id}/entry-nodesGet entry nodes for a version

​
Workflow Execution

MethodEndpointDescription
POST/workflow-requests/runRun a workflow
GET/workflow-requests/{id}/listenStream execution updates (SSE)
GET/workflow-requests/{id}/execution-treeGet complete execution hierarchy
GET/workflow-requests/{id}/historyGet past executions
POST/workflow-requests/{id}/stopStop a running workflow

​
Chats

MethodEndpointDescription
POST/chatsCreate a new chat session
GET/chats/{resourceType}/{resourceId}List chats for a resource
GET/chats/{id}Get a chat session
DELETE/chats/{id}Delete a chat session
GET/chat-history/{chatId}/paginatedGet paginated message history
DELETE/chat-history/{chatId}Delete all message history
GET/chat-internal-messages/{chatId}/listenStream chat events (SSE)

​
Events

MethodEndpointDescription
POST/events/{webhook_id}Receive external event via webhook

​
Billing

MethodEndpointDescription
GET/billing/balanceGet current account balance
GET/billing/transactionsGet paginated transaction history
GET/activity/statsGet aggregate activity statistics
GET/activity/dailyGet daily spending and usage data

​
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: 
{
  "workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8"
}
Use this ID to listen for results, get the execution tree, or check history.

​
SSE Streaming

SSE endpoints (/listen) use standard Server-Sent Events format: 
data: {"workflow_request": {...}, "node_execution": {...}}

data: keepalive
  • Keepalive messages sent every 3 seconds
  • Connection timeout: 30 minutes (reconnect if needed)

​
Rate Limits

EndpointLimit
POST /workflow-requests/run20 per minute per user

​
Support