# API reference

This section reorganizes the Pinot API surface into broker query APIs, query response formatting, controller admin APIs, controller API examples, and broker gRPC. The goal is to keep the overview light while still documenting the endpoint-level behavior operators and client authors need.

## Reference Map

| Area                    | Use it for                                                         | Source page                                                                |
| ----------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| Broker query API        | SQL query submission, broker cursors, and response-store lifecycle | [Broker Query API](/reference/api-reference/query-api.md)                  |
| Query response format   | Response fields and cursor payload structure                       | [Query Response Format](/reference/api-reference/query-response-format.md) |
| Controller admin API    | Swagger UI walkthrough for cluster and table administration        | [Controller Admin API](/reference/api-reference/controller-admin-api.md)   |
| Controller API examples | Endpoint families and representative admin requests                | [Controller API Examples](/reference/api-reference/controller-api.md)      |
| Broker gRPC             | gRPC query transport and client configuration                      | [Broker gRPC API](/reference/api-reference/broker-grpc-api.md)             |

## What this page covered

* The main Pinot API surfaces and their intended use.
* Which pages in this subtree contain endpoint-level detail.
* Where to go for query, controller, and gRPC reference material.

## Next step

Pick the API family you need, then cross-check the request and response examples against the component you are targeting.

## Related pages

* [Broker Query API](/reference/api-reference/query-api.md)
* [Query Response Format](/reference/api-reference/query-response-format.md)
* [Controller Admin API](/reference/api-reference/controller-admin-api.md)
* [Controller API Examples](/reference/api-reference/controller-api.md)
* [Broker gRPC API](/reference/api-reference/broker-grpc-api.md)


---

# Agent Instructions: 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:

```
GET https://docs.pinot.apache.org/reference/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.