Support API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
POST /api/v1/support/chat
Support Chat
Request body
| Field | Required | Type | Description |
|---|---|---|---|
messages | Yes | array | |
language | No | string |
Any authenticated staff user. Rate-limited to 20 requests per minute. The AI Support Assistant's question-answering chat. Runs on the studio's own AI configuration (see Studio → AI Assistant configuration); without one it answers in basic mode.
Responses
-
200 — Successful Response
{"reply": "…","mode": "basic","docs_results": [{"title": "Memberships","excerpt": "A membership gives a client credits to book classes…","doc_path": "studio-manager/memberships.md"}]}Field Type Description replystring The assistant's answer. In basic mode, a fixed localized message. mode"ai"|"basic"aiwhen AI is configured (an LLM answers, or a static greeting/out-of-scope reply short-circuits it);basicwhen it isn't.docs_resultsarray | null Set (possibly empty) only on a basic-mode search reply: {title, excerpt, doc_path}keyword-search hits.nullotherwise.Basic mode makes no LLM call, no embedding call and no network call.
-
422 — Validation Error
-
429 — Rate limit exceeded (20/minute).
The response fields above aren't captured by fetch-openapi.js's regeneration — added by hand
from app/routers/support.py. Keep them if this page is regenerated.