Comprehensive integration guide for frontend/full-stack developers:
- Architecture overview diagram
- Quick start (submit + poll in ~20 lines)
- Model lifecycle: state machine diagram, all 4 /model/* endpoints,
SSE event subscription with JS examples
- Job submission: multipart fields, 503 model_not_ready handling,
retry-with-auto-load pattern
- Job progress: polling vs SSE, all event types with payloads
- Webhooks: job completion + model lifecycle, Express receiver example,
how to distinguish job vs model payloads
- Health check field reference
- Cancellation semantics (GPU inference not interruptible)
- Full TypeScript type definitions for all API shapes
- React hooks: useModelStatus, useJobStream, useTranscribe
- Complete WhisperClient class example with ensureModelReady,
streamProgress, and end-to-end transcribe()
- Error reference table with all 400/404/409/503/500 shapes
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bcaf8680db