知眸核心版开放平台
  1. 任务
知眸核心版开放平台
  • 核心版开放接口
    • 接口说明
    • 更新记录
    • 接口错误码
    • 授权
      • 授权接口
    • 应用
      • 获取应用列表
      • 下发应用
      • 修改应用配置
      • 删除应用
    • 任务
      • 创建分析任务
        POST
      • 配置分析任务
        PUT
      • 上报任务图片
        POST
      • 上报任务飞行状态数据
        POST
      • 关闭分析任务
        DELETE
      • 获取分析任务列表
        GET
      • 指定规则AI直播推流
        POST
      • 关闭AI直播推流
        DELETE
    • 回调
      • Mqtt任务数据发布
      • 消息回调接口
    • 报告
      • 导出任务报告
  1. 任务

创建分析任务

POST
/api/task
任务分为视频分析任务和图片分析任务,创建任务时通过请求参数mode设置,默认为视频分析任务
mode设置为"video",任务属于视频分析任务
mode设置为"image", 任务属于图片分析任务
任务为视频分析任务时,开启任务时拉流超时时间为15秒,视频流异常断开后会执行补黑帧,持续5分钟视频流没续上,任务自动关闭。
任务为图片分析任务时,图片上报最低间隔为1秒,最长间隔为5分钟,超过5分钟无最新上报图片,任务自动关闭
输出视频分辨率:
输出视频分辨率宽高都为0时,输出视频分辨率为输入视频流分辨率
输出视频分辨率宽和高都不为0时,输出视频分辨率缩放到指定宽高
输出视频分辨率宽或高其中只有一个值为0时,输出视频分辨率按原视频宽高比缩放
输出视频比特率:
指定比特率为0时,输出视频比特率为输入视频比特率

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer {{token}}
Body 参数application/json
mode
string 
任务类型
可选
video | image 默认视频任务
app_id
string 
应用唯一ID
必需
rules
array[string]
指定开启应用下规则列表
可选
不指定,则开启所有规则
disable_rules
array[string]
指定应用下禁用的规则
可选
business_id
string 
三方业务ID
可选
device
string 
设备号
可选
input
string 
视频任务输入流
可选
output
string 
视频任务输出流
可选
width
integer 
输出视频宽
可选
height
integer 
输出视频高
可选
bitrate
integer 
输出视频比特率
可选
osd
object 
输出OSD配置
可选
display_name
boolean 
是否展示目标名称
可选
display_box
boolean 
是否展示目标框
可选
display_mask
boolean 
是否展示目标遮罩
可选
display_track
boolean 
是否展示目标追踪ID
可选
display_count
boolean 
是否展示右上角计数模块
可选
display_speed
boolean 
是否展示画面像素速度
可选
速度单位为 像素/秒,开发测试用
display_angle
boolean 
是否展示运动方向角
可选
方向单位为 角度,开发测试用
font_size
integer 
字体大小
可选
border_size
integer 
框体粗细
可选
hide_rule
array[string]
在输出视频流中不展示的规则列表
可选
polygon
array [array] 
视频画面过滤区域
可选
dji
object 
大疆MQTT配置
可选
device_sn
string 
无人机设备码
必需
大疆无人机设备SN
mqtt
object 
MQTT订阅配置
必需
report
object 
数据推送配置
可选
httpurl
string 
http消息回调接口地址
可选
mqtt
object 
任务状态数据推送
可选
不传时可使用配置文件中配置
示例
{
    "mode": "string",
    "app_id": "string",
    "rules": [
        "string"
    ],
    "disable_rules": [
        "string"
    ],
    "business_id": "string",
    "device": "string",
    "input": "string",
    "output": "string",
    "width": 0,
    "height": 0,
    "bitrate": 0,
    "osd": {
        "display_name": true,
        "display_box": true,
        "display_mask": true,
        "display_track": true,
        "display_count": true,
        "display_speed": true,
        "display_angle": true,
        "font_size": 0,
        "border_size": 0,
        "hide_rule": [
            "string"
        ],
        "polygon": [
            [
                0
            ]
        ]
    },
    "dji": {
        "device_sn": "string",
        "mqtt": {
            "broker_host": "string",
            "broker_port": 0,
            "ssl": true,
            "client_id": "string",
            "username": "string",
            "password": "string"
        }
    },
    "report": {
        "httpurl": "string",
        "mqtt": {
            "broker_host": "string",
            "broker_port": 0,
            "ssl": true,
            "client_id": "string",
            "username": "string",
            "password": "string",
            "topic": "string",
            "qos": 0,
            "lwt": {
                "enable": true,
                "retain": true,
                "topic": "string",
                "qos": 0,
                "message": "string"
            }
        }
    }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST '/api/task' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mode": "string",
    "app_id": "string",
    "rules": [
        "string"
    ],
    "disable_rules": [
        "string"
    ],
    "business_id": "string",
    "device": "string",
    "input": "string",
    "output": "string",
    "width": 0,
    "height": 0,
    "bitrate": 0,
    "osd": {
        "display_name": true,
        "display_box": true,
        "display_mask": true,
        "display_track": true,
        "display_count": true,
        "display_speed": true,
        "display_angle": true,
        "font_size": 0,
        "border_size": 0,
        "hide_rule": [
            "string"
        ],
        "polygon": [
            [
                0
            ]
        ]
    },
    "dji": {
        "device_sn": "string",
        "mqtt": {
            "broker_host": "string",
            "broker_port": 0,
            "ssl": true,
            "client_id": "string",
            "username": "string",
            "password": "string"
        }
    },
    "report": {
        "httpurl": "string",
        "mqtt": {
            "broker_host": "string",
            "broker_port": 0,
            "ssl": true,
            "client_id": "string",
            "username": "string",
            "password": "string",
            "topic": "string",
            "qos": 0,
            "lwt": {
                "enable": true,
                "retain": true,
                "topic": "string",
                "qos": 0,
                "message": "string"
            }
        }
    }
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
可选
task_id
string 
任务ID
必需
示例
{
    "code": 0,
    "msg": "ok",
    "data": {
        "task_id": "1719366930_5"
    }
}
修改于 2025-03-18 04:12:51
上一页
删除应用
下一页
配置分析任务
Built with