> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/api.md).

# API

- [API Overview](https://docs.netmap.dev/api/api-overview.md): How NetMap's REST API is exposed, authenticated, versioned, and documented.
- [API Keys](https://docs.netmap.dev/api/api-keys.md): Generate, authenticate with, rotate, revoke, secure, and troubleshoot NetMap API keys.
- [API Authentication](https://docs.netmap.dev/api/authentication.md): Authenticate REST requests to NetMap.
- [Generating API Keys](https://docs.netmap.dev/api/generating-api-keys.md): Create API keys through the UI or API.
- [Using API Keys](https://docs.netmap.dev/api/using-api-keys.md): Make authenticated NetMap API requests with X-API-Key.
- [API-Key Permissions](https://docs.netmap.dev/api/api-key-permissions.md): Understand how API keys inherit user roles.
- [Rotating API Keys](https://docs.netmap.dev/api/rotating-api-keys.md): Replace an API key without downtime.
- [Revoking API Keys](https://docs.netmap.dev/api/revoking-api-keys.md): Revoke own or all-user API keys.
- [API Errors](https://docs.netmap.dev/api/errors.md): NetMap API error envelope and common statuses.
- [Rate Limits](https://docs.netmap.dev/api/rate-limits.md): API-key, tools, discovery, and login rate limits.
- [OpenAPI And Swagger](https://docs.netmap.dev/api/openapi-swagger.md): Use NetMap's generated FastAPI schema.
- [Capability Matrix](https://docs.netmap.dev/api/capability-matrix.md): What the UI and API keys can do.
- [Endpoint Inventory](https://docs.netmap.dev/api/api-reference.md): Verified FastAPI route inventory, authentication groups, and API-key capability matrix.
- [Endpoint Reference](https://docs.netmap.dev/api/endpoint-reference.md): Endpoint inventory and schema entry point.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.