Skip to content

REST API ​

Base URL: http://<orchestrator-host>:<port> (default port: 8001)

All responses are JSON unless noted. Timestamps are RFC 3339. Layer indices are 0-based, exclusive end (start_layer..end_layer).

Every endpoint ​

Each endpoint's page, by area:

Chat and models API ​

Generation and artifacts API ​

Audio and images API ​

Nodes, metrics and admin API ​

Authentication ​

Admin endpoints require the X-Admin-Token header:

X-Admin-Token: <token>

The token is set with --admin-token when starting the orchestrator.
Without a token configured, all admin routes return 403.


System ​

GET /health ​

Returns orchestrator liveness, and how many nodes are connected.

Response 200

json
{ "ok": true, "version": "0.8.5", "nodes": 2, "visual_nodes": 1, "mode": "local" }

nodes counts text nodes and visual_nodes image and video nodes (dppan join --visual). A machine that joined as both is in each count.

Error Format ​

All errors return JSON:

json
{ "error": "human-readable description" }

Common status codes:

CodeMeaning
400Bad request / missing field
403Missing or invalid admin token
404Node or resource not found
409Conflict (e.g. duplicate node_id)
422Capability mismatch / unknown model
503No nodes available / layer gap

Free to run · Proprietary