Skip to content

Cognitive Systems App Cloud API

The AppCloud APIs are used by mobile applications to communicate with the Cognitive Systems Infrastructure.

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

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"
}

Update Sensor or Hub Configuration

Request

Updates the configuration of a sensor or hub.

IMPORTANT: The app must set notify: true. The cloud cannot do this on the occurrence of the DeviceAddedEvent because of a ThirdReality and App Cloud race condition. (3R propogates the device added faster than the device record in their cloud).

Propagates an IntegrationsConfigChangedEvent containing the payload of the configuration change.

Path
THING_NAMEstringrequired

Sensor or Hub thingName.

Bodyapplication/json
friendlyNamestring

Friendly name, propagates to 3rd Reality and stored within App Cloud.

Default ""
emailNotifyboolean

Email notification of sensor detections. App Cloud will always override this to false because account identifiers in ThirdReality are anonymous and uniquely system generated strings with no real world email inbox.

Default false
locationNamestring

Location name of a sensor, stored within App Cloud only and associated to sensor events.

Default ""
tempThresholdinteger[ 1 .. 100 ]

Sets the expected temperature delta for which a s SensorChangedValue event is sent from ThirdReality.

humidThresholdinteger[ 1 .. 100 ]

Sets the expected humidity delta for which a SensorChangedValue event is sent from ThirdReality.

notifyboolean

Enables the sensor eventing for a given sensor. Newly added sensors default to false and must be changed to true for App Cloud to receive and store sensor values.

Default false
purposestring

Defines the expected assignment or purpose of a given sensor for sensor event pattern detection and correlation to WiFi Motionâ„¢. Enables labeled data consistency in analytics and household occupancy trend analysis.

Any one of:

  • FrontDoorVibration

  • BackDoorVibration

  • RefrigeratorVibration

  • BathroomSensor

  • DoorSensor

  • MainHub

  • SecondaryHub

  • SideDoorVibration

Default ""
curl -i -X PATCH \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/devices/{THING_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
    "notify": true,
    "friendlyName": "Grandma'\''s Bathroom",
    "locationName": "Upstairs Bathroom",
    "tempThreshold": 5,
    "humidThreshold": 5,
    "purpose": "BathroomSensor"
  }'

Responses

201 Created

Bodyapplication/json
Response
application/json
{
  "id": 3,
  "network_id": 1,
  "external_id": 4,
  "userThingName": "USER_c9d3c1ee5cd2458da1843095422f4141",
  "thingName": "SENSOR_7C3E822F74460000",
  "config": {
    "notify": true,
    "online": false,
    "humidity": 68,
    "emailNotify": false,
    "temperature": 23.1,
    "batteryLevel": 100,
    "friendlyName": "Grandma's Bathroom",
    "locationName": "Upstairs Bathroom",
    "tempThreshold": 5,
    "humidThreshold": 5
  },
  "deviceType": "SensorThLite",
  "purpose": "BathroomSensor",
  "created_at": "2025-07-15T17:08:48.732Z",
  "updated_at": "2025-07-16T18:28:27.760Z"
}

Delete Sensor or Hub

Request

Removes a sensor or hub. Deleting a Hub also includes the removal and deletion of associated child sensors. This deletion propagates to the Third Reality Cloud and will dispatch DeviceRemoved events for each sensor which will remove the sensors from App Cloud's Devices list. Sensors that are deleted need to be re-paired by being placed into pairing mode using the physical reset button. Removed Hubs will need to also be physically reset and provided userThingName and WiFi ssid / password via Bluetooth.

Path
THING_NAMEstringrequired

Sensor or Hub thingName.

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

Responses

204 No Content