API reference

API reference for Pinot query and controller endpoints.

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
Query response format	Response fields and cursor payload structure	Query Response Format
Controller admin API	Swagger UI walkthrough for cluster and table administration	Controller Admin API
Controller API examples	Endpoint families and representative admin requests	Controller API Examples
Broker gRPC	gRPC query transport and client configuration	Broker gRPC API

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

• Query Response Format

• Controller Admin API

• Controller API Examples

• Broker gRPC API