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.
Cognitive Systems App Cloud API
Download OpenAPI description
Languages
Servers
Mock server
https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/
https://docs.cognitivesystems.com/api/v1/
Path
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 networkall: Attempts to delete all nodes within the network
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/node/{node_id}
- https://docs.cognitivesystems.com/api/v1/node/{node_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/node/{node_id}'- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}
- https://docs.cognitivesystems.com/api/v1/networks/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Request
- Updates App Cloud network with user-specific information. User must have the role "owner" for the corresponding network.
- Request body does not require all listed fields, but fields must match type and value validations
To update the timezone, only pass timezone in the request body:
{ "timezone": "Europe/Warsaw" }
Security
Authorization
- Mock serverhttps://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}
- https://docs.cognitivesystems.com/api/v1/networks/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.cognitivesystems.com/_mock/assets/specs/api/app_cloud/networks/{id}?expand=string' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"address": "string",
"latitude": 0,
"longitude": 0,
"timezone": "string",
"pet_size": "string",
"scene_id": 0,
"building_type": "string",
"building_size": "string",
"live_enabled": true,
"id": 0
}'Response
application/json
{ "id": 0, "address": "string", "building_size": "string", "building_type": "string", "latitude": "string", "longitude": "string", "live_enabled": true, "name": "string", "pet_size": "string", "timezone": "string", "user_count": 0, "created_at": "string", "updated_at": "string", "external_id": 0, "scene_id": 0, "present_count": 0, "claimed": true, "network_scene_config": {}, "owner_email": "string", "subscription_id": "string" }