> For the complete documentation index, see [llms.txt](https://docs.kiloiot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kiloiot.io/kilo-docs-pt/kilo-iot-server/api.md).

# API

Visão geral da API do Kilo IoT Server — acesso REST e gRPC, chaves com âmbito e pontos de integração na cloud ou on-premise.

A Plataforma Kilo IoT expõe acesso programático para que sistemas externos possam ler e gerir os dados e a configuração da sua implementação — e agora enviar comandos para os seus dispositivos — abrangendo integrações de backend, análises e pipelines de relatórios, ferramentas industriais e de automatização, e aplicações personalizadas.

Use a [**referência da API**](https://api.kiloiot.io/) para a lista completa de endpoints, campos do pedido, respostas e âmbitos necessários. Esta secção cobre para que serve a API, como escolher um protocolo, como os pedidos se autenticam e onde gerir chaves.

> O controlo de dispositivos faz parte da API: uma chave com o **Comandos** escopo pode criar comandos de um dispositivo e enviá-los como downlinks (ligar/desligar, setpoints e afins). Veja [Comandos do dispositivo](/kilo-docs-pt/kilo-iot-server/devices/commands.md) para o fluxo de trabalho na app, e o [referência da API](https://api.kiloiot.io/#tag/commands) para os endpoints de comandos.

## O que está disponível

São oferecidos dois protocolos no mesmo endpoint seguro:

* **REST** — o caminho principal para a maioria das integrações. HTTPS e JSON padrão, utilizáveis a partir de qualquer cliente HTTP. Comece aqui, a não ser que tenha uma razão específica para não o fazer. Veja [API REST Pública](/kilo-docs-pt/kilo-iot-server/api/public-rest-api.md).
* **gRPC** — o caminho avançado / on-premise. Escolha REST, a menos que precise especificamente de gRPC para uma integração on-premise ou tipada de serviço para serviço. Veja [API gRPC](/kilo-docs-pt/kilo-iot-server/api/grpc-api.md).

Em paralelo, um endpoint separado serve clientes de IA, em vez do código que escreve:

* **MCP** — ligue um cliente de IA compatível com MCP, como o Claude Code ou o Claude Desktop, à sua organização. Autorize-o no navegador com a sua conta Kilo habitual, em vez de emitir uma chave, e ele funciona dentro das suas próprias permissões. Veja [Servidor MCP](/kilo-docs-pt/kilo-iot-server/api/mcp-server.md).

## Autenticação

Os pedidos são autenticados com uma chave de API com escopo no `X-API-Key` cabeçalho (formato `kilo_<key>`), mais o contexto da sua organização em `X-Organization-Id`. As chaves são criadas e geridas em **Definições → Chaves de API**; os conceitos estão resumidos em [Autenticação e chaves de API](/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md), e o fluxo de trabalho completo de gestão de chaves está em [Chaves API](/kilo-docs-pt/kilo-iot-server/settings/api-keys.md).

## Cloud e on-premise

As implementações na cloud usam o endpoint gerido acima. As instalações on-premise expõem a mesma API dentro da sua própria fronteira de rede, onde o gRPC é uma solução natural para automatização interna de serviço para serviço — mas o REST continua disponível e continua a ser o ponto de partida mais simples.

## Nesta secção

* [API REST Pública](/kilo-docs-pt/kilo-iot-server/api/public-rest-api.md) — o caminho de integração padrão.
* [API gRPC](/kilo-docs-pt/kilo-iot-server/api/grpc-api.md) — o caminho avançado / on-premise (tipado, serviço para serviço).
* [Servidor MCP](/kilo-docs-pt/kilo-iot-server/api/mcp-server.md) — ligue o seu próprio cliente de IA à sua organização.
* [Autenticação e chaves de API](/kilo-docs-pt/kilo-iot-server/api/authentication-and-api-keys.md) — como os pedidos são autorizados.
* [Exemplos](/kilo-docs-pt/kilo-iot-server/api/examples.md) — um pedido autenticado mínimo para começar.


---

# 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.kiloiot.io/kilo-docs-pt/kilo-iot-server/api.md?ask=<question>&goal=<endgoal>
```

`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.