API
POST /api/senses/devices
Register Device
POST /api/senses/devices
Register Device
Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Org-ID | header | string | null | No | - |
Request body
A JSON request body is required.
| Field | Type | Required | Description |
|---|---|---|---|
device_type | string | Yes | - |
device_name | string | Yes | - |
device_uid | string | Yes | - |
platform | string | null | No | - |
os_version | string | null | No | - |
app_version | string | null | No | - |
capabilities | string[] | No | Defaults to ["presence"]. |
metadata | object | No | Defaults to {}. |
Example request
curl -X POST https://api.cognitivx.io/api/senses/devices \
-H "Authorization: Bearer icog_..." \
-H "Content-Type: application/json" \
-d '{
"device_type": "semantic",
"device_name": "production",
"device_uid": "string",
"platform": null,
"os_version": null,
"app_version": null,
"capabilities": [
"presence"
],
"metadata": {}
}'Example response
201 application/json
{}Responses
| Status | Description |
|---|---|
201 | Created. The new resource is returned in the response body. |
422 | Request validation failed. detail lists each offending field. |