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

Sensor Integration is the process where a standalone sensor (like a Motion Tag or Bath Sensor) establishes a secure communication link with the WiFi Motion Plug network.

Operations

Obtain Sensor Integration

Request

Get Integration configuration.

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

Responses

200 OK

Bodyapplication/json
idinteger
integration_enabledboolean
network_idinteger
external_idinteger
user_idinteger
userThingNamestring
oob_phasestring
created_atstring
updated_atstring
Response
application/json
{
  "integrations": {
    "id": 18,
    "integrations_enable": true,
    "network_id": 1,
    "external_id": 4,
    "user_id": 101,
    "userThingName": "USER_a0b1c2de3fg4567hi8901234567j8901",
    "oob_phase": "",
    "created_at": "2025-06-06T16:01:07.715Z",
    "updated_at": "2025-06-06T16:01:07.715Z"
  }
}

Update Sensor Integration

Request

Mutate fields of an initialized integration.

Bodyapplication/json
integrations_enableboolean
oob_phasestring
curl -i -X PATCH \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/sensors/integrations \
  -H 'Content-Type: application/json' \
  -d '{
    "integrations_enable": true,
    "oob_phase": "started"
  }'

Responses

201 Created

Bodyapplication/json
idinteger
integration_enabledboolean
network_idinteger
external_idinteger
user_idinteger
userThingNamestring
oob_phasestring
created_atstring
updated_atstring
Response
application/json
{
  "integrations": {
    "id": 18,
    "integrations_enable": true,
    "network_id": 1,
    "external_id": 4,
    "user_id": 101,
    "userThingName": "USER_a0b1c2de3fg4567hi8901234567j8901",
    "oob_phase": "",
    "created_at": "2025-06-06T16:01:07.715Z",
    "updated_at": "2025-06-06T16:01:07.715Z"
  }
}

Delete Sensor Integration

Request

Deletes an integration, cascades the deletion to any added devices from the devices table, and purges the sensor detection history for the given network. Propagates an IntegrationDeletedEvent containing the userThingName. Deletes the account and hardware association in ThirdReality.

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

Responses

204 No Content