Skip to Content
API Reference
API Reference

API Reference

The full API Reference documentation has moved to our dedicated API docs site for a better developer experience.


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_KEY

Base URL: https://docs.nunu.ai

Endpoints

EndpointDescription
/llms.txtCompact documentation summary for LLMs
/full-llms.txtComplete documentation in LLM-friendly format
/{section}/llms.txtDocumentation for a specific section
/{path}/page.mdIndividual 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.md

Error Responses

Status CodeDescription
401Missing or invalid API key
403API key lacks docs:read permission
404Page not found
Last updated on