> For the complete documentation index, see [llms.txt](https://docs.chirpwireless.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chirpwireless.io/api/grpc-api.md). # gRPC API Chirp also offers a gRPC interface. For almost everyone at home you won't need it — **REST is the practical choice for home scripts and integrations** (see [REST API](/api/public-rest-api.md)). **gRPC is the advanced / on-premise path: use it only if you specifically need it for an on-premise or typed service-to-service integration.** ## When it's worth it Reach for gRPC only if you specifically want a typed, generated client and a fixed contract inside your own software, or direct service-to-service calls in a more involved or self-hosted setup. Otherwise REST covers what a typical home script or integration needs, with far less setup. ## How it works gRPC uses the same key-based sign-in as REST — `X-API-Key` plus your home context (see [Authentication & API keys](/api/authentication-and-api-keys.md)). The [API reference](https://api.chirpwireless.io/) lists the available gRPC services and methods. For native gRPC client definitions, use the materials provided with your on-premise or integration package. ## See also * [REST API](/api/public-rest-api.md) — start here. * [Authentication & API keys](/api/authentication-and-api-keys.md) --- # 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://docs.chirpwireless.io/api/grpc-api.md?ask=&goal= ``` `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.