Ingest points through a connector

curl --request POST \
  --url https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "deviceExternalId": "<string>",
      "deviceExternalPath": "<string>",
      "pointExternalId": "<string>",
      "pointExternalPath": "<string>",
      "pointName": "<string>",
      "pointKind": "<string>",
      "pointUnit": "<string>",
      "pointEnum": "<string>",
      "pointWritable": true,
      "pointMinVal": 123,
      "pointMaxVal": 123
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        deviceExternalId: '<string>',
        deviceExternalPath: '<string>',
        pointExternalId: '<string>',
        pointExternalPath: '<string>',
        pointName: '<string>',
        pointKind: '<string>',
        pointUnit: '<string>',
        pointEnum: '<string>',
        pointWritable: true,
        pointMinVal: 123,
        pointMaxVal: 123
      }
    ]
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points"

payload = { "items": [
        {
            "deviceExternalId": "<string>",
            "deviceExternalPath": "<string>",
            "pointExternalId": "<string>",
            "pointExternalPath": "<string>",
            "pointName": "<string>",
            "pointKind": "<string>",
            "pointUnit": "<string>",
            "pointEnum": "<string>",
            "pointWritable": True,
            "pointMinVal": 123,
            "pointMaxVal": 123
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "items": [
    {
      "deviceExternalId": "<string>",
      "deviceExternalPath": "<string>",
      "pointExternalId": "<string>",
      "pointExternalPath": "<string>",
      "pointName": "<string>",
      "pointKind": "<string>",
      "pointUnit": "<string>",
      "pointEnum": "<string>",
      "pointWritable": true,
      "pointMinVal": 123,
      "pointMaxVal": 123
    }
  ]
}'

{
  "_id": "<string>",
  "organizationId": "<string>",
  "createdAt": "2026-10-28T13:51:31+0000",
  "updatedAt": "2026-10-28T13:51:31+0000",
  "name": "<string>",
  "description": "<string>",
  "status": "PENDING",
  "errorMessage": "<string>"
}

POST

https://api.kodelabs.com/kodeos

api

buildings

{buildingId}

connectors

{connectorId}

ingest

points

Ingest points through a connector

curl --request POST \
  --url https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "deviceExternalId": "<string>",
      "deviceExternalPath": "<string>",
      "pointExternalId": "<string>",
      "pointExternalPath": "<string>",
      "pointName": "<string>",
      "pointKind": "<string>",
      "pointUnit": "<string>",
      "pointEnum": "<string>",
      "pointWritable": true,
      "pointMinVal": 123,
      "pointMaxVal": 123
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        deviceExternalId: '<string>',
        deviceExternalPath: '<string>',
        pointExternalId: '<string>',
        pointExternalPath: '<string>',
        pointName: '<string>',
        pointKind: '<string>',
        pointUnit: '<string>',
        pointEnum: '<string>',
        pointWritable: true,
        pointMinVal: 123,
        pointMaxVal: 123
      }
    ]
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points"

payload = { "items": [
        {
            "deviceExternalId": "<string>",
            "deviceExternalPath": "<string>",
            "pointExternalId": "<string>",
            "pointExternalPath": "<string>",
            "pointName": "<string>",
            "pointKind": "<string>",
            "pointUnit": "<string>",
            "pointEnum": "<string>",
            "pointWritable": True,
            "pointMinVal": 123,
            "pointMaxVal": 123
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/connectors/{connectorId}/ingest/points' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "items": [
    {
      "deviceExternalId": "<string>",
      "deviceExternalPath": "<string>",
      "pointExternalId": "<string>",
      "pointExternalPath": "<string>",
      "pointName": "<string>",
      "pointKind": "<string>",
      "pointUnit": "<string>",
      "pointEnum": "<string>",
      "pointWritable": true,
      "pointMinVal": 123,
      "pointMaxVal": 123
    }
  ]
}'

{
  "_id": "<string>",
  "organizationId": "<string>",
  "createdAt": "2026-10-28T13:51:31+0000",
  "updatedAt": "2026-10-28T13:51:31+0000",
  "name": "<string>",
  "description": "<string>",
  "status": "PENDING",
  "errorMessage": "<string>"
}

The request is checked first and then runs as a job. A 202 response means the job started, not that the points exist yet. Read the job with Get a job until status is COMPLETED, then read the points back. A job has no result for each item.

Send 1 to 1,000 items in one request. Each item describes one point and the device it belongs to.

Member	Meaning
`deviceExternalId`, `deviceExternalPath`	The `deviceExternalId` and `deviceExternalPath` you sent when you ingested the parent device. Required.
`pointExternalId`	Your own stable identifier for the point. Required.
`pointExternalPath`	The path of the point in your system. Required.
`pointName`	The name shown in KODE OS. Required, up to 255 characters.
`pointKind`	`Number`, `Str`, or `Bool`. Required. The value is case-sensitive.
`pointUnit`	The `_id` of an ontology unit, for a `Number` point. Optional.
`pointEnum`	The allowed values as one comma-separated string, such as `off,on,auto`. Optional.
`pointWritable`	`true` if the point accepts writes. Optional, `false` when you leave it out.
`pointMinVal`, `pointMaxVal`	The lowest and highest value, as numbers. Optional. `pointMinVal` cannot be higher than `pointMaxVal`.

The request returns 400 before any job starts when:

A parent device was not ingested on this connector. The message lists the missing deviceExternalId values.
A pointUnit is not an ontology unit. The message lists the unknown ids.
A pointKind is not Number, Str, or Bool.
A point has pointMinVal higher than pointMaxVal.
The connector is not a KODE API connector.

Send a pointExternalId that exists already and the API does not create a second point. A buildingId in the body is ignored.

Authorizations

Authorization

string

header

required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId

string

required

Building identifier from List buildings.

connectorId

string

required

ID of a KODE API connector, from _id in Create a KODE API connector.

Body

application/json

items

object[]

required

Required array length: 1 - 1000 elements

Show child attributes

Response

The job that was started, with status PROCESSING.

_id

string

organizationId

string

createdAt

string

read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt

string

read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name

string

description

string

status

enum<string>

Available options:

PENDING,

PROCESSING,

PROCESSED,

COMPLETED,

FAILED,

CANCELED

errorMessage

string

Get started

Guides

API reference

Ingest points through a connector

Authorizations

Path Parameters

Body

Response