> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# What is the KODE API?

> Use the KODE API to build services and integrations with KODE OS building and operations data.

The KODE API is the programmatic interface to KODE OS. Use it to build integrations, automate operations, and work with building data at scale.

KODE teams use the API across internal services and delivery workflows. The same versioned interface supports customer and partner integrations.

> [card] [Send your first request](https://docs.kodelabs.com/products/kode-api/quickstart.md)
>
> Get a token and list your buildings in about five minutes.

> [card] [Browse the API reference](https://docs.kodelabs.com/products/kode-api/api-reference/introduction.md)
>
> Explore every endpoint and try requests in the browser.

> [card] [Fork in Postman](https://elements.getpostman.com/view/fork?collection=37847641-0db06e08-772a-492b-9a93-f5d18c67b15c\&documenterCollectionId=37847641-0db06e08-772a-492b-9a93-f5d18c67b15c-2sAYkEqfGB\&referrer=https%3A%2F%2Fdocumenter.getpostman.com%2Fview%2F37847641%2F2sAYkEqfGB\&versionTag=latest\&source=documenter)
>
> Copy the KODE API collection into your Postman workspace, then run the requests there.

## What you can build

* **Data ingestion**: Create devices and points, then send current or historical values from your system.
* **Building data export**: Read buildings, devices, points, and timeseries into analytics or reporting tools.
* **Equipment control**: Write to writable points, such as setpoints and overrides.
* **Maintenance workflows**: Create, update, and sync AssetOps work orders with external systems.

## How the API works

The KODE API uses resource-oriented HTTPS endpoints with JSON bodies. Most resources sit under a building:

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/...
```

Every request needs a Bearer access token. Your service gets the token by signing a client assertion with the private key issued for your client ID. See [Authentication](https://docs.kodelabs.com/products/kode-api/authentication.md).

Service accounts use scoped permissions by building and operation. The API returns only the resources assigned to your service account.

## Find your way around

| Section | Use it to |
| - | - |
| Get started | Set up credentials and learn conventions shared by every endpoint. |
| Guides | Follow end-to-end workflows, such as ingesting device data or writing to points. |
| API reference | Look up endpoint parameters and schemas, and send test requests. |

## API lifecycle

The `/api/v1/` path identifies the current major version. KODE can add backward-compatible fields and endpoints within this version, so ignore response fields your integration does not recognize.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.