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

# Swarm Nexus API

Learn more about documenting APIs in GitBook.

## API Introduction

Welcome to the Swarm Nexus Agent API! This API provides programmatic, read-only access to the Swarm Memory, allowing developers to build applications, run analytics, and integrate Torus ecosystem data into their own services.

#### Base URL

All API endpoints are relative to the following base URL:

`https://swarm-nexus.xyz/agent`

#### General Principles

* **Read-Only:** The API is strictly for reading data. No `POST`, `PUT`, `PATCH`, or `DELETE` requests are supported.
* **Public & Unauthenticated:** Access to the API is public. You do not need an API key or any other form of authentication to use it.
* **JSON Responses:** All endpoints return data in JSON format.
* **CORS Enabled:** The API has Cross-Origin Resource Sharing (CORS) enabled (`Access-Control-Allow-Origin: *`), so you can make requests directly from browser-based applications.
* **Rate Limiting:** While the API is public, it is subject to rate limiting to ensure fair usage and stability. If you exceed the rate limit, you will receive a `429 Too Many Requests` response. Please use the API responsibly.


---

# 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://swarmnexus.gitbook.io/swarmnexus/api-reference/readme.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.