Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reolink AI API

AI-powered object detection, auto-tracking, and autofocus

Reolink AI API is one of 11 APIs that Reolink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include AI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 9 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 8.0.

Requests are made against a single base URL, https://{camera_ip}.

8 operations 8 paths 3 schemas 8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.0
Server
https://{camera_ip}
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Reolink AI API declares 1 security scheme for authenticating requests. An API key is passed in the query as token (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Authentication token obtained from the Login command. Pass as a query parameter on all requests after authentication.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 POST. Each is listed below with its method, path, parameters, and response codes.

AI 8

AI-powered object detection, auto-tracking, and autofocus

POST
/cgi-bin/api.cgi?cmd=GetAiAlarm&token={token}
Get AI detection alarm settings
getAiAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAiAlarm&token={token}
Set AI detection alarm settings
setAiAlarm 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAiState&token={token}
Get AI detection state
getAiState 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAiCfg&token={token}
Get AI configuration
getAiCfg 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAiCfg&token={token}
Set AI configuration
setAiCfg 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAutoFocus&token={token}
Get autofocus settings
getAutoFocus 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=GetAutoTrack&token={token}
Get auto-tracking settings
getAutoTrack 1 param body → 200
POST
/cgi-bin/api.cgi?cmd=SetAutoTrack&token={token}
Set auto-tracking settings
setAutoTrack 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CommandResponse (4 properties), CommandRequest (3 properties), ChannelRequest (3 properties). Each schema is shown below with its type and property counts.

ChannelRequest
object
3 properties 3 required
CommandRequest
object
3 properties 2 required
CommandResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reolink-ai-api-openapi.yml Raw ↑

Other APIs Reolink publishes across the network.

Reolink Alarm API
Reolink Authentication API
Reolink Encoding API
Reolink LED API
Reolink Network API
Reolink PTZ API
Reolink Recording API
Reolink Security API
Reolink System API
Reolink Video API