REST API

The app service serves everything over HTTP: the dashboard at /app, the API under /api, and /health. The runtime has its own control API, but it's only reachable on the compose network and is never published.

GET /healthCopy Anchor Link

Public and unauthenticated. Use it for uptime checks.

GET /health

The response is JSON with the schema version and connector state. This example is illustrative, not an exact schema:

{
  "ok": true,
  "schema": { "db": 4, "code": 4 },
  "connectors": [
    { "id": "telegram", "status": "on" },
    { "id": "whatsapp", "status": "error", "detail": "unlinked" },
    { "id": "cliproxy", "status": "on" }
  ]
}

• It fails when the database schema is newer than the code. That's what makes a bad rollback show up as failed. See Upgrades.
• Runtime connector state is reported in the body, not in the status code. A WhatsApp outage shows as error in the JSON while /health itself stays healthy, so a channel problem never fails a deploy.

POST /api/hooks/:slugCopy Anchor Link

Receives an event for an inbound webhook. The request must carry x-palui-timestamp (unix seconds, within 5 minutes of now) and x-palui-signature: sha256=<hex HMAC-SHA256 of "<timestamp>.<raw body>">, signed with the hook's secret. A repeated signature is refused with 409, and a body over 256 KB with 413. See Inbound webhooks for the signing example and the forward and summarize modes.

POST /api/hooks/my-hook
content-type: application/json
x-palui-timestamp: 1794283200
x-palui-signature: sha256=<signature>

{"event":"deploy","status":"ok"}

/api/auth/*Copy Anchor Link

Authentication is handled by Better Auth with passkeys. Sign-up is disabled from the first boot: there's no endpoint that creates an account from outside. The owner account comes from a single-use invite created on the Docker host:

docker compose exec app palui owner invite

The invite link is valid for 15 minutes. It's also how you recover from a lost passkey.

Dashboard APICopy Anchor Link

The dashboard talks to session-authenticated JSON endpoints under /api. They cover:

• Connectors: list, connect, configure, test, pause, resume, remove.
• Chats: the chat list, transcripts, the web chat, approval answers.
• Reminders and jobs: list, create, change, run now, pause.
• Activity: events, runs and token usage.
• Settings: persona, timezone, language, model roles and failover, budgets.

They need a signed-in dashboard session. They aren't a stable public contract in v1 and can change between releases. Don't build on them.