The assistant is available on Pro and Enterprise plans and is enabled by default for those plans.
About the assistant
The assistant answers questions about your documentation through natural language queries. Users access the assistant on your documentation site, so they can find answers quickly and succeed with your product even if they don’t know where to look. The assistant uses agentic RAG (retrieval-augmented generation) with tool calling. When users ask questions, the assistant:- Searches and retrieves relevant content from your documentation to provide accurate answers.
- Builds context from the page a user is viewing when they ask questions.
- Cites sources and provides navigable links to take users directly to referenced pages.
- Returns detailed API information when answering questions about your API, including methods, parameters, request bodies, and response schemas from your OpenAPI specifications.
- Generates copyable code examples to help users implement solutions from your documentation.
- Supports multiple modalities by allowing users to add text, images, and other files as context.
How indexing works
The assistant indexes your published documentation and API specifications to answer questions accurately. When you publish changes, the assistant immediately indexes new, updated, or deleted content. The assistant does not index draft branches or preview deployments. By default, the assistant does not index hidden pages. To include hidden pages in the assistant’s index, setseo.indexing: "all" in your docs.json. See Hidden pages for more information.
How the assistant handles unknown questions
The assistant only answers questions based on information in your documentation. If it cannot find relevant information after searching, it responds that it doesn’t have enough information to answer. You can set a deflection email so that the assistant provides your support email to users whose questions it cannot answer. This gives users a path forward, even if the documentation doesn’t address their specific question.Assistant insights
Use assistant insights to understand how users interact with your documentation and identify improvement opportunities. The assistant page shows usage trends for the month to date. View more detailed insights on the analytics page.Make content AI ingestible
Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.Structure and organization
- Use semantic markup.
- Write descriptive headings for sections.
- Create a logical information hierarchy.
- Use consistent formatting across your docs.
- Include comprehensive metadata in page frontmatter.
- Break up long blocks of text into shorter paragraphs.
Context
- Define specific terms and acronyms when first introduced.
- Provide sufficient conceptual content about features and procedures.
- Include examples and use cases.
- Cross-reference related topics.
- Add hidden pages with additional context that users don’t need, but the assistant can reference.