Cortex
Documentation

Read your device data over one REST API

Your systems authenticate with an API key, then read devices, series, telemetry and alarms over HTTPS. Your side opens every connection, so there is no inbound firewall rule and nothing to install. Select an endpoint to see its parameters, an example call and every response it can return.

Quick start · 10 minutes
  1. Exchange your API key for a bearer token.
  2. Call /v1/summary to confirm the token resolves to your organisation.
  3. List the series you hold with /v1/telemetry/series.
  4. Read one of them over a range with /v1/telemetry.
  5. Poll /v1/alarms for what needs attention.
BASE="https://api-cortex.aid-iot.com"

# 1. Authenticate. The token, not the key, goes on every later call.
TOKEN=$(curl -s -X POST "$BASE/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{"apiKey":"'"$AID_API_KEY"'"}' | jq -r .token)

# 2. Confirm which organisation it resolved to.
curl -s "$BASE/v1/summary" -H "Authorization: Bearer $TOKEN"

# 3. Discover what actually holds data.
curl -s "$BASE/v1/telemetry/series" -H "Authorization: Bearer $TOKEN"

# 4. Read seven days of one series at ~600 points.
curl -s -G "$BASE/v1/telemetry" -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "deviceId=clean-b-temp-04" \
  --data-urlencode "metric=temperature" \
  --data-urlencode "from=2026-09-01T00:00:00Z" \
  --data-urlencode "to=2026-09-08T00:00:00Z" \
  --data-urlencode "agg=avg" --data-urlencode "width=600"

Authentication

One call, one bearer token. Every other request carries it.

Discovery

What your organisation has: the estate, and the series that actually hold data.

Telemetry

The principal endpoint: one series, one range, at the resolution you ask for.

Alarms

Read what needs attention, and acknowledge it from your own console.

Device requests

Ask for a newly installed device to be registered.

Across every endpoint

How errors behave, what the budgets are, and how to keep a mirror in step.

This is the whole contract: every endpoint above, and every rule that spans them. Anything you cannot find here, write to [email protected] and we will answer it — and then add it to this page.