API Reference
The full API Reference documentation has moved to our dedicated API docs site for a better developer experience.
Quick Links
- Introduction - Overview of the nunu.ai API
- Authentication - API key setup and permissions
- Runs API - Manage test runs programmatically
- Builds API - Upload and manage builds
Give Your LLM Access to the Docs
Programmatic access to nunu.ai documentation in LLM-friendly formats. Useful for AI agents, chatbots, or automated tools that need to reference the docs.
Authentication
All endpoints require an API key with docs:read permission. Pass the key in the X-Api-Key header:
GET /llms.txt
X-Api-Key: YOUR_API_KEYBase URL: https://docs.nunu.ai
Endpoints
| Endpoint | Description |
|---|---|
/llms.txt | Compact documentation summary for LLMs |
/full-llms.txt | Complete documentation in LLM-friendly format |
/{section}/llms.txt | Documentation for a specific section |
/{path}/page.md | Individual page in markdown format |
LLM-Friendly Formats
/llms.txt
A compact summary of the documentation, optimized for LLM context windows.
curl -H "X-Api-Key: YOUR_API_KEY" https://docs.nunu.ai/llms.txt/full-llms.txt
The complete documentation in a single file. Use when you need comprehensive coverage.
curl -H "X-Api-Key: YOUR_API_KEY" https://docs.nunu.ai/full-llms.txt/{section}/llms.txt
Documentation for a specific section only. Available sections match the docs navigation.
curl -H "X-Api-Key: YOUR_API_KEY" https://docs.nunu.ai/nexus/llms.txt/{path}.md
Any documentation page is available in raw markdown by appending .md to the page path.
# Get the nunu-cli quick start guide
curl -H "X-Api-Key: YOUR_API_KEY" https://docs.nunu.ai/ci-cd-integration/build-storage/quick-start.mdError Responses
| Status Code | Description |
|---|---|
401 | Missing or invalid API key |
403 | API key lacks docs:read permission |
404 | Page not found |
Last updated on