Ask AI
Ask AI gives your users instant answers from your published documentation, directly inside your hub. It appears on every page — a user types a question, gets a response grounded in your content with links to the source pages, and keeps moving without opening a support ticket. You control the tone, answer length, forbidden topics, and example questions. Analytics show what users are asking, so you can identify gaps in your docs.
Getting Started
- Open AI → Ask AI in your project settings.
- Set the assistant's tone, answer length, and forbidden topics.
- Add example questions that users see when they first open Ask AI.
- Select a model.
- Click Save.
Configure
Customize Ask AI from AI → Ask AI:
- Tone — The voice of the assistant (formal, friendly, neutral).
- Answer length — How detailed responses are.
- Forbidden topics — Subjects the assistant will not address.
- Example questions — Prompts users see when they first open Ask AI.
- Model — Which AI model generates responses.
Enterprise Groups
Group-level configurations apply across all child projects. Set them in your Group Dashboard.
Analytics
The Ask AI dashboard shows what users are asking and how the assistant is performing. Open it from Analytics → Ask AI.
- Questions — Every question users have asked.
- Responses — The AI-generated answers.
- Feedback — Thumbs up/down ratings from users.
- Export — CSV download with custom date ranges (Enterprise only).
Example
A developer building against your API visits your docs and asks:
"How do I authenticate with OAuth? I need to get an access token for server-to-server calls."
Ask AI searches your published documentation, finds your "Authentication" guide and the OAuth section of your API Reference, and responds:
"To authenticate with OAuth for server-to-server calls, create a client credentials grant by POSTing to
/oauth/tokenwith yourclient_idandclient_secret. The response includes anaccess_tokenvalid for 3600 seconds. See Authentication > OAuth for the full flow and POST /oauth/token for the endpoint details."
The response includes direct links to the source pages. The developer clicks through, reads the full guide, and starts building — without opening a support ticket or searching through 50 pages.
If a question comes up repeatedly in your analytics, it's a signal that a page is missing or unclear.
FAQ
What happens to my data?
Ask AI is powered by OpenAI. Your Markdown content and API definitions are sent to generate answers. OpenAI retains API request logs for 30 days but does not use this data for model training.
Does Ask AI reference hidden pages?
No. Hidden pages are never indexed. For Enterprise groups, answers are scoped to content the user has access to.
How quickly are documentation changes reflected?
Content is re-indexed every 2 hours.
How can I try Ask AI?
Test it on ReadMe's own docs, or enable it on your project as a trial.
What plan do I need?
Ask AI is available on all plans.