> 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**](https://developers.bead.xyz/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 and paste. |
| [**Download OpenAPI**](https://developers.bead.xyz/reference-guide/endpoint-index/download-openapi.md) | The link to the OpenAPI JSON file and how to request access. The file requires a Bead login.          |

### 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, sign in and download the OpenAPI file from [**Download OpenAPI**](https://developers.bead.xyz/reference-guide/endpoint-index/download-openapi.md), then import it into Swagger, Insomnia, or Postman. If you do not have a Bead login, request one from Integration Support.

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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.bead.xyz/reference-guide/endpoint-index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
