Skip to content

Device APIs

1. Prerequisites

Base URL: https://api.rokid.com

2. Overview

Device APIs expose registration lookup, querying and teardown so integrations can inspect Glass units.

2.1 List devices

Endpoint https://api.rokid.com/ar/core/openapi/device/list

Method POST

Request application/json

Response */*

Parameters

NameDescriptionRequiredType
deviceSnSN substring searchfalsestring
deviceNameFriendly name substringfalsestring

Response fields

NameDescriptionRequiredType
deviceSnSerial numbertruestring
deviceNameDevice nametruestring
deviceTypeGLASS3 enterprise · GLASS3_LITE · GLASS_OTHERtruestring
statusConnection: online / offlinetruestring

Example

bash
curl -X POST https://api.rokid.com/ar/core/openapi/device/list \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "deviceSn":"1901",
    "deviceName":"glass3"
}'

Sample response

json
{
  "code": 0,
  "message": "OK",
  "data": [
    {
      "deviceName": "glass3_001715",
      "deviceSn": "1901092524001715",
      "deviceType": "GLASS3",
      "status": "offline"
    }
  ],
  "success": true
}