Docs assistant

The assistant behind Ask AI in these docs.

Method	Path
POST	/api/v1/docs/ask

Ask the docs

POST /api/v1/docs/ask

Answers questions about this documentation (RAG over the vol-docs dataset). Powers Ask AI.

From the API schema: Public. Answers questions about VOL using a RAGFlow assistant over the docs.

Auth: Public — no credentials

Request body

{
  "question": "How do I stream a chat answer?"
}

cURL

curl -X POST "https://vol.example.com/api/v1/docs/ask" \
  -H "Content-Type: application/json" \
  -d '{"question":"How do I stream a chat answer?"}'

TypeScript

import { VolClient } from "@vol/sdk";

const vol = new VolClient({ baseUrl: "https://vol.example.com/api" });
await vol.docsAsk("How do I stream a chat answer?");

Python

import os, requests

r = requests.post(
    "https://vol.example.com/api/v1/docs/ask",
    json={
      "question": "How do I stream a chat answer?"
    },
    timeout=60,
)
r.raise_for_status()
print(r.json())

Response 200

{
  "answer": "Send `stream: true` to `POST /v1/chat` and read the SSE events…",
  "sources": [
    {
      "title": "Chat & streaming",
      "url": "/docs/guides/chat-streaming/"
    }
  ]
}