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

Update Node Settings

Request

Security
Authorization
Bodyapplication/json
friendly_namestring

The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand. For example, if referring to a location, it is easier for an end user to refer to a location as "Bedroom" rather than the mac address of the device that is located in the bedroom.

locationstring
network_idintegerrequired
node_idintegerrequired
curl -i -X PUT \
  https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/node \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "string",
    "location": "string",
    "network_id": 0,
    "node_id": 0
  }'

Responses

OK

Delete Node

Request

Path
node_idinteger or stringrequired

You can delete a single node from the network by specifying the integer value of the node which can be obtained using the Get Client State endpoint. If you want to delete all nodes within the network, then you can specify the string all.

  • integer: Attempts to delete a single node from the network

  • all: Attempts to delete all nodes within the network

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

Responses

200 OK

Response
No content

Show General Settings (With ID)

Request

  • The network_scene_configs field in the res json defaults to an int which represents the row_id of the scene config in postgres.
  • To retrieve the full scene config for the network, use the expand param with a single array item of network_scene_config
Security
Authorization
Path
idintegerrequired
Query
expandArray of strings
Items Value"network_scene_config"
curl -i -X GET \
  'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}?expand=network_scene_config' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger
Example: "http://json-schema.org/schema#"
addressstring
building_sizestring
building_typestring
latitudestring
longitudestring
live_enabledboolean
name(string or null)
(string or null)
pet_sizestring
timezonestring
user_countnumber
created_atstring
updated_atstring
external_idinteger
scene_idinteger
present_countinteger
claimedboolean
owner_emailstring
network_scene_config(object or null) or (integer or null)
Any of:
object or null
subscription_idstring or null
Response
application/json
{
  "id": "http://json-schema.org/schema#"
}

Sounding v2

Operations

Events, History, and Visualizations

Operations

Household Insights

Operations

Zone Priority

Operations

Universal Alerting

Operations

Meta

Operations

Sensor Integration

Operations