> 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/api/grpc-api.md).

# gRPC API

Kilo IoT Server gRPC API — typed service-to-service path for on-premise installs, same scoped API-key auth.

**gRPC** is an API protocol that lets one program call defined operations in another using structured messages and generated client code. Kilo's gRPC interface is intended for integrations that need those typed service contracts, particularly in on-premise environments.

Use it when your integration package supplies the service definitions and endpoint details. You also need the appropriate [API credentials and scopes](/api/authentication-and-api-keys.md). For most cloud scripts and business-system integrations, start with the [Public REST API](/api/public-rest-api.md).

## When to use gRPC

* A typed, generated client and a stable service contract in your own software.
* Direct service-to-service integration, including on-premise installations connecting internal systems within their own network.

## How it works

gRPC uses the same scoped API-key authentication as REST — `X-API-Key` plus organization context (see [Authentication & API keys](/api/authentication-and-api-keys.md)). The [API reference](https://api.kiloiot.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

* [Public REST API](/api/public-rest-api.md)
* [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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.kiloiot.io/api/grpc-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.