AiDBox API / MQTT / Webhook 参考

AiDBox 对外提供三类集成通道:REST API(管理端 + AI Host)、MQTT(设备 ↔ 平台长连接)与 HTTP Webhook(事件推送)。本文覆盖常用端点;字段级完整说明请参见随产品提供的接口文档,或联系艾域智能技术支持。
REST API
| 类别 | 路由前缀 | 说明 |
|---|---|---|
| 管理端接口 | /gtw/cwai/... |
模型仓库、场景任务、系统配置等管理操作 |
| AI Host 核心接口 | /v1/cwai/aihost/...、/gtw/cwai/aihost/... |
任务创建/取消(TaskCreate / PTaskCreate)、图片检测(PTaskDetectPic)、节点操作(OperateNode)、概览记录等 19 个端点 |
| 存活检查 | Probe |
唯一免认证端点;其余均需携带有效 mtk 令牌 |
MQTT 接入
设备连接后先订阅平台到设备的两个 topic,然后完成注册与心跳:
| 方向 / 动作 | Topic | 说明 |
|---|---|---|
| 设备 → 平台(注册) | /d2p/aibox |
连接后发送注册消息,携带设备标识与能力信息 |
| 设备 → 平台(心跳) | /d2p/aibox/heartbeat |
注册成功后每 30 秒一次 |
| 平台 → 设备(下发请求) | 订阅 topic(见接口文档) | 任务创建、参数变更等控制指令 |
| 设备 → 平台(响应) | 对应响应 topic | 执行结果与状态回执 |
外层消息结构、注册/心跳字段与请求-响应格式详见随产品提供的 MQTT 接入参考文档,或联系艾域智能技术支持获取。
HTTP Webhook 事件推送
在系统配置中设置接收 URL(如 http://example.com/aibox/events),告警事件以 JSON POST 推送。典型负载:
{
"orignalPicture": "/data/event/original.jpg", // 原始画面
"fullPicture": "/data/event/full.jpg", // 全图叠加
"detectedPicture":"/data/event/target.jpg", // 目标截图
"video": "/data/event/alarm.mp4", // 告警短视频
"videostructured":" /data/event/structured.json",// 结构化结果
"overviewFile": "/data/event/overview.json" // 概览信息
}
-
property对象随算法类型变化(不同算法输出不同的业务字段); -
接收端建议:幂等处理、异步落库、失败重试。
集成建议
-
轻量对接:只用 Webhook 收事件 + REST API 做管理操作;
-
平台级接入:MQTT 长连接承载控制面,Webhook 承载事件面;
-
安全:生产环境务必修改默认密码、启用 mtk 认证与 TLS。