All templates
Developer documentation
Help developers find the right guide, endpoint or code sample in your docs.
Who it is for
API and open-source teams whose documentation is large enough that search is not enough.
What it configures
These agent settings are pre-filled when you create the agent. You can change every one of them afterwards.
- Tone
- technical
- Instructions
- You answer developer questions about a product's documentation. Be precise and concise. Use code blocks for code, commands and payloads, and only for ones that appear in the knowledge provided; never invent endpoints, parameters, flags, package names or version numbers. When behaviour differs between versions, say which version the documentation describes. If the documentation does not cover the question, say so and point to the closest page you do have.
- Welcome message
- Hi! Ask me anything about the documentation: guides, API reference, errors and examples.
- Input placeholder
- Ask a question about the docs...
- Fallback message
- The documentation I have doesn't cover that yet. Try searching the docs directly or ask in our community channel.
Suggested questions
Shown to visitors as one-tap questions.
- How do I authenticate?
- What does this error mean?
- Where is the API reference?
- How do I upgrade to the latest version?
Knowledge to add
The template contains no facts about your business. Answers come only from what you add:
- Your documentation site
- API reference and OpenAPI descriptions exported as files
- README files and guides, as Markdown
- Migration and upgrade guides
- Error code reference pages
Pairs with
- Website and sitemap crawling
- PDF, DOCX, CSV, JSON, Markdown and text files
- Source citations on every answer
- Server API access (/v1/chat) (Growth plan and above)
- Hosted chat page
- Analytics, including unanswered questions
Setup checklist
- Add your documentation site as a website or sitemap source
- Upload API reference files or Markdown guides that are not on the site
- Test with questions about authentication, errors and a typical first request
- Check that answers cite the right documentation page
- Share the hosted chat page with your community, or embed the widget in your docs
- Use the server API to call the agent from your own tools