Skip to content

Cognitive Systems App Cloud API

The App Cloud APIs expose the Core API endpoints, but with the addition of adding per user authentication and authorization. For example, you may choose to build with App Cloud APIs when developing for a mobile platform.

Download OpenAPI description
app_cloud.json
app_cloud.yaml
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud
https://docs.cognitivesystems.com/api/v1

Overview

Operations

Out of Box

Operations

Logging In

Operations

Geofencing

Operations

Account Management

Operations

Network Settings

Operations

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations

Initialize Hub Pairing Mode

Request

Initializes the HUB into Sensor Pairing Mode by the thingName of the hub. The HUB's LED colour will change to a flashing green during Pairing Mode, and will return to a steady blue when no longer in Pairing Mode. A longer timeout can be short circuited to a shorter one by making a subsequent call with a shorter timeout.

Path
HUB_THING_NAMEstringrequired

A Hub ThingName, must be prefixed with HUB_

Bodyapplication/json
timeoutinteger[ 1 .. 3600 ]

Timeout value in seconds.

curl -i -X POST \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/pair/{HUB_THING_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "timeout": 60
  }'

Responses

201 Created

Bodyapplication/json
Response
application/json
{
  "timeout": 60
}

Obtain Configuration for All Devices

Request

Once sensors are paired, this API retrieves the list of all devices (hubs and sensors) associated to the WiFi Motionâ„¢ network. Calling this API synchronizes and updates sensor and hub states from the ThirdReality cloud.

curl -i -X GET \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/devices

Responses

200 OK

Bodyapplication/json
Response
application/json
{
  "devices": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Obtain Configuration for a Device by ThingName

Request

Once sensors are paired to a HUB, this API synchronizes state from the ThirdReality cloud for a single device. Any new devices will

Path
THING_NAMEstringrequired

Sensor or Hub thingName.

curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/devices/{THING_NAME}'

Responses

200 OK

Bodyapplication/json
Response
application/json
{
  "id": 1,
  "network_id": 1,
  "external_id": 4,
  "userThingName": "USER_c9d3c1ee5cd2458da1843095422f4141",
  "thingName": "SENSOR_282C02BFFFECBFEC",
  "config": {
    "notify": true,
    "online": true,
    "status": "closed",
    "batteryLevel": 100,
    "friendlyName": "Door Sensor 1"
  },
  "deviceType": "SensorDoor",
  "purpose": "",
  "created_at": "2025-07-15T17:08:48.732Z",
  "updated_at": "2025-07-16T18:06:19.312Z"
}