> 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.md). # API Chirp gives you programmatic access to your home's data — and now the ability to send commands to your devices — for personal scripts, local dashboards, spreadsheets, and trusted integrations with other home-automation tools. Use the [**API reference**](https://api.chirpwireless.io/) for the complete list of calls, request fields, responses, and required scopes. This section covers what the API is for, how requests are signed, and where to get a key. > You can control a device through the API too: a key with the **Commands** scope can send a device its commands — turn it on or off, dim a light, change a setting. See [Device Commands](/devices/commands.md) for the in-app way, or the [API reference](https://api.chirpwireless.io/) for the command calls. ## REST is the way in For home scripts and integrations, the **REST API** is the practical starting point: plain HTTPS and JSON that works from any language, tool, or no-code automation. Almost anything you'd want at home — read a sensor's latest value, pull history into a spreadsheet, bridge readings into another smart-home platform — is a REST call. See [REST API](/api/public-rest-api.md). A **gRPC API** also exists — the advanced / on-premise path. It is not the normal homeowner path: for home scripts and tools use REST, and reach for gRPC only if you specifically need it for an on-premise or typed service-to-service integration. See [gRPC API](/api/grpc-api.md). ## Signing requests Each request carries a scoped API key in the `X-API-Key` header (format `chirp_`) and your home's context in `X-Organization-Id`. You create and manage keys in **Settings → API Keys**; the essentials are in [Authentication & API keys](/api/authentication-and-api-keys.md), and the full walkthrough is in [API Keys](/settings/api-keys.md). ## In this section * [REST API](/api/public-rest-api.md) — the normal way to connect scripts and tools. * [gRPC API](/api/grpc-api.md) — only for advanced typed-client or service integrations. * [Authentication & API keys](/api/authentication-and-api-keys.md) — how requests are signed. * [Examples](/api/examples.md) — a first authenticated request. --- # 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.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.