> For the complete documentation index, see [llms.txt](https://developers.bead.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bead.xyz/reference-guide/endpoint-index.md).

# Endpoint Index

### Purpose

Endpoint Index is the one-stop directory for every public Bead API path. Use it to locate a call quickly, copy a URL, or jump to the full reference page without scanning multiple sections.

### What’s inside

| Page                                                                                  | What you’ll find                                                                                                                     |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| [**Table View**](/reference-guide/endpoint-index/table-view-all-apis.md)              | A table listing every path, method, and one-line purpose. Ideal for quick look-ups or copy-paste.                                    |
| [**Download OpenAPI / Postman**](/reference-guide/endpoint-index/download-openapi.md) | Direct links to the live OpenAPI JSON files (sandbox and production) and a note that ready-made Postman collections are coming soon. |

### How to use this section

1. Open **Table View** and find or Ctrl + F to find the endpoint you need.
2. Click the path (or follow the sidebar) to jump to the detailed docs for that call.
3. If you prefer machine-readable specs, grab the OpenAPI URL from [**Download OpenAPI / Postman** ](/reference-guide/endpoint-index/download-openapi.md)and import it into Swagger, Insomnia, or Postman.

Endpoints are updated automatically whenever the platform releases; check the changelog for additions or breaking changes.


---

# 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://developers.bead.xyz/reference-guide/endpoint-index.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.