API Reference

This is the REST API and WebSocket interface for the Creature Server. All endpoints are prefixed with the server’s base URL. The server communicates over HTTP/1.1 and WebSocket on a local LAN.

Most endpoints accept and return application/json. A few accept raw binary audio or raw JSON strings. Async operations return a job ID immediately and report progress over the WebSocket.

Sections

  • Animations — Stored and ad-hoc animations, playback, interruption, and lip sync.
  • Creatures — Configure creatures, register controllers, and toggle the idle loop.
  • Fixtures (DMX) — E1.31 lighting: config, universe assignment, patterns, and live control.
  • Multi-Character Dialog — Multi-creature scenes, saved scripts, and on-disk preview.
  • Playlists — Ordered sequences of animations per universe.
  • Sounds — Stored and ad-hoc sound files, playback, and lip sync.
  • Streaming Sessions — Real-time, sentence-by-sentence conversation.
  • Storyboards — Tappable tile cards driven by the Creature Console.
  • Voice & Speech-to-Text — ElevenLabs voice generation and whisper.cpp transcription.
  • WebSocket & Conventions — Realtime messages, status codes, the error envelope, plus debug and metrics endpoints.