1. 与核心版接口改动说明
知眸开放平台
  • 部署文档
  • 接口错误码
  • 更新记录
  • 授权
    • 授权接口
      POST
  • 应用
    • 获取应用列表
      GET
  • 任务
    • 开启任务
      POST
    • 获取任务列表
      GET
    • 结束任务
      DELETE
    • 更新任务配置
      PUT
    • 上传任务图片
      POST
    • 获取指定应用AI视频
      POST
    • 关闭指定应用AI视频
      DELETE
  • 回调
    • Mqtt任务数据订阅
    • 消息回调接口
      POST
  • 流媒体
    • 获取视频流
      POST
    • 释放视频流
      DELETE
  • 与核心版接口改动说明
    • 核心版卸载
    • 授权模块
    • 应用模块
    • 任务模块
    • 回调
  1. 与核心版接口改动说明

任务模块

3.1 创建任务 POST /api/task#

旧版接口名:POST /api/task
请求方式、请求路径两版一致。

1. 请求体字段#

字段名旧版新版变更类型变更说明
zapk_id-string、必选新增字段应用包ID, 即旧版app_id
app_ids-array、必选新增字段应用ID列表, 即旧版的rules
device_id-string、可选新增字段设备ID, 即旧版的device
video_url-string、可选新增字段即旧版的input
report_url-string、可选新增字段即旧版的report下的httpurl
modestring、可选string、可选无变更任务类型
business_idstring、可选string、可选无变更业务ID
osdobject、可选object、可选数据结构变更视频绘制配置
disable_rulesarray、可选-删除字段字段已移除
devicestring、可选-删除字段字段已移除
inputstring、可选-删除字段字段已移除
outputstring、可选-删除字段字段已移除
widthinteger、可选-删除字段字段已移除
heightinteger、可选-删除字段字段已移除
bitrateboolean、可选-删除字段字段已移除
frame_ignoreboolean、可选-删除字段字段已移除
djiobject、可选-删除字段字段已移除
reportobject、可选-删除字段字段已移除

2. osd子级字段#

字段名旧版新版变更类型变更说明
display_nameboolean、可选boolean、可选无变更显示目标名称
display_boxboolean、可选boolean、可选无变更显示目标框
display_trackboolean、可选boolean、可选无变更显示追踪ID
font_sizeinteger、可选integer、可选无变更字体大小
border_sizeinteger、可选integer、可选无变更边框大小
display_maskboolean、可选-删除字段字段已移除
display_countboolean、可选-删除字段字段已移除
display_speedboolean、可选-删除字段字段已移除
display_angleboolean、可选-删除字段字段已移除
hide_rulearray、可选-删除字段字段已移除
polygonarray、可选-删除字段字段已移除

3.2 获取任务列表 GET /api/tasks#

旧版接口名:GET /api/tasks
请求方式、请求路径两版一致。

1. data字段#

字段名旧版新版变更类型变更说明
dataobject、必选array、必选数据结构变更任务列表

2. task对象字段#

新版移除最外层的tasks字段
字段名旧版新版变更类型变更说明
zapk_id-string、必选新增字段应用包ID, 即旧版app_id
app_ids-array、必选新增字段应用ID列表, 即旧版的rules
device_id-string、可选新增字段设备ID, 即旧版的device
video_url-string、可选新增字段即旧版的input
report_url-string、可选新增字段即旧版的report下的httpurl
close_code-integer、可选新增字段任务结束码
dump-string、可选新增字段任务校验码
task_idstring、必选string、必选无变更任务ID
modestring、可选string、可选无变更任务类型
business_idstring、可选string、可选无变更业务ID
osdobject、可选object、可选数据结构变更视频绘制配置
disable_rulesarray、可选-删除字段字段已移除
devicestring、可选-删除字段字段已移除
inputstring、可选-删除字段字段已移除
outputstring、可选-删除字段字段已移除
widthinteger、可选-删除字段字段已移除
heightinteger、可选-删除字段字段已移除
bitrateboolean、可选-删除字段字段已移除
frame_ignoreboolean、可选-删除字段字段已移除
djiobject、可选-删除字段字段已移除
reportobject、可选-删除字段字段已移除

3. osd子级字段#

字段名旧版新版变更类型变更说明
display_nameboolean、可选boolean、可选无变更显示目标名称
display_boxboolean、可选boolean、可选无变更显示目标框
display_trackboolean、可选boolean、可选无变更显示追踪ID
font_sizeinteger、可选integer、可选无变更字体大小
border_sizeinteger、可选integer、可选无变更边框大小
display_maskboolean、可选-删除字段字段已移除
display_countboolean、可选-删除字段字段已移除
display_speedboolean、可选-删除字段字段已移除
display_angleboolean、可选-删除字段字段已移除
hide_rulearray、可选-删除字段字段已移除
polygonarray、可选-删除字段字段已移除

3.3 关闭任务 DELETE /api/task/{task_id}#

无变更

3.4 更新任务 PUT /api/task/{task_id}#

旧版接口名:PUT /api/task/{task_id}

接口变更#

项目旧版新版变更类型变更说明
app_ids-array、可选新增能力支持动态切换应用
osd-object、可选新增能力支持动态修改绘制配置
display_nameboolean、可选boolean、可选无变更显示目标名称
display_boxboolean、可选boolean、可选无变更显示目标框
display_trackboolean、可选boolean、可选无变更显示追踪ID
font_sizeinteger、可选integer、可选无变更字体大小
border_sizeinteger、可选integer、可选无变更边框大小
hide_rulearray、可选-删除字段字段已移除
display_maskboolean、可选-删除字段字段已移除
display_countboolean、可选-删除字段字段已移除
display_speedboolean、可选-删除字段字段已移除
display_angleboolean、可选-删除字段字段已移除
polygonarray、可选-删除字段字段已移除

3.5 上传任务图片 POST /api/task/{task_id}/image#

旧版接口名:POST /api/task/{task_id}/image

Query参数#

字段名旧版新版变更类型变更说明
device_id-string、可选新增字段设备ID,即旧版的device
image_id-integer、可选新增字段图片ID,即旧版的id
enhance-integer、可选新增字段图片增强识别
devicestring、可选-删除字段字段已移除
idinteger、可选-删除字段字段已移除

请求体#

无变更

3.5 获取AI视频 POST /api/task/{task_id}/ailive#

旧版接口名: POST /api/task/{task_id}/ailive

请求体字段#

字段名旧版新版变更类型变更说明
rtmp-string、可选新增字段指定推流地址,即旧版的output
bitrate-integer、可选新增字段视频码率
app_ids-array、必选新增字段应用ID列表,即旧版的rules
outputstring、可选-删除字段字段已移除
widthinteger、可选-删除字段字段已移除
heightinteger、可选-删除字段字段已移除
rulesarray、可选-删除字段字段已移除

3.6 关闭AI视频 DELETE /api/task/{task_id}/livestream/{stream}#

无变更

3.7 移除其他任务接口#

上报任务飞行状态数据
POST /api/task/{task_id}/flight
修改于 2026-06-10 17:16:46
上一页
应用模块
下一页
回调
Built with