MobiariDocs

Ask the documentation

POST
/docs/ask

Answers a question about Mobiari from its documentation, streamed. Public (the docs site and the admin's help panel call it); limited to 20 questions per hour per visitor and a daily total. The response is the AI SDK UI message stream (text/event-stream, header x-vercel-ai-ui-message-stream: v1): data: lines carrying JSON objects with type start, text-start, text-delta {id, delta}, text-end, source-url {sourceId, url, title} for each documentation page the answer cites, then finish or error {errorText}, and a final data: [DONE].

Header Parameters

Idempotency-Key?string

A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

text/event-stream

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/docs/ask" \  -H "Content-Type: application/json" \  -d '{    "messages": [      {        "parts": [          {}        ],        "role": "string"      }    ]  }'
"string"
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}
{
  "code": "not_found",
  "details": {},
  "error": "Order not found"
}