Health and Queue

Workshop exposes both public and authenticated health routes.

Public Health

GET/health

Public health check

Returns basic service reachability. No auth required.

bash
curl "$WORKSHOP_URL/health"
json
{ "status": "ok", "version": "1.0.0" }

Authenticated Health

GET/api/health

Authenticated health and capabilities

Returns deployment capabilities including persistence, object storage, renderer, source preprocessing, and queue state.

bash
curl "$WORKSHOP_URL/api/health" \
  -H "x-api-key: $WORKSHOP_API_KEY"

The response is useful for deployment checks and runbooks because it reports configured render engine, native renderer health, persistence health, object storage backend, source preprocessing support, uptime, and queue information.

Queue Status

GET/api/queue

Render queue status

Returns current queue depth and job state for render operations.

bash
curl "$WORKSHOP_URL/api/queue" \
  -H "x-api-key: $WORKSHOP_API_KEY"

Deployment Checks

For a healthy staging deployment, verify:

  • GET /health returns status: ok.
  • GET /api/health works with an API key.
  • Persistence reports ready when Postgres features are expected.
  • Object storage backend and base URL match the deployment plan.
  • Render engine is native unless explicitly testing fallback behavior.
  • Queue status is visible before submitting long renders.

Next Steps