有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

接口请求域名: iss.tencentcloudapi.com 。

添加AI任务

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddAITask。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
Name String AI 任务名称。仅支持中文、英文、数字、_、-,长度不超过32个字符
示例值:测试任务
ChannelList.N Array of String 通道 ID 列表。不能添加存在于其他 AI 任务的通道,限制1000个通道。
示例值:f8656fa3-e7fa-4cad-a4cc-****
Templates.N Array of AITemplates AI 配置列表
Desc String AI 任务描述。仅支持中文、英文、数字、_、-,长度不超过128个字符
示例值:用于测试
CallbackUrl String AI 结果回调地址。类似 "http://ip:port/***或者https://domain/*
示例值:https://****
IsStartTheTask Boolean 是否立即开启 AI 任务。"true"代表立即开启 AI 任务,"false"代表暂不开启 AI 任务,默认为 false。
示例值:true

3. 输出参数

参数名称 类型 描述
Data AITaskInfo AI任务信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 失败示例

包含无效的通道ID

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAITask
<公共请求参数>

{
    "Name": "ai-task",
    "Desc": "测试",
    "ChannelList": [
        "**********************"
    ],
    "CallbackUrl": "http://*******",
    "Templates": [
        {
            "Tag": "AI",
            "AIConfig": {
                "DetectType": "Pet",
                "TimeInterval": 10,
                "OperTimeSlot": [
                    {
                        "Start": "10:00:00",
                        "End": "20:00:00"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.ContainInvalidChannelId",
            "Message": "包含无效的通道ID"
        },
        "RequestId": "d380c0bc-2be1-4620-bf39-9d4d4f512060"
    }
}

示例2 成功示例

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAITask
<公共请求参数>

{
    "Name": "ai-task",
    "Desc": "测试",
    "ChannelList": [
        "97308958-6122-4188-8c78-d5ff8010bdf7"
    ],
    "CallbackUrl": "http://**********",
    "Templates": [
        {
            "Tag": "AI",
            "AIConfig": {
                "DetectType": "Pet",
                "TimeInterval": 10,
                "OperTimeSlot": [
                    {
                        "Start": "10:00:00",
                        "End": "20:00:00"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "CallbackUrl": "http://**********",
            "ChannelList": [
                "**********************"
            ],
            "CreatedTime": "2023-06-15 15:50:47",
            "Desc": "测试",
            "Name": "ai-task",
            "Status": "off",
            "TaskId": "at**********************8",
            "Templates": [
                {
                    "AIConfig": {
                        "DetectType": "Pet",
                        "OperTimeSlot": [
                            {
                                "End": "20:00:00",
                                "Start": "10:00:00"
                            }
                        ],
                        "TimeInterval": 10
                    },
                    "Tag": "AI"
                }
            ],
            "UpdatedTime": "2023-06-15 15:50:47"
        },
        "RequestId": "4ea417f6-da0e-4211-9b97-6408070b9851"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue.CallbackURLContainIllegalCharacter CallbackURL包含特殊字符
InvalidParameterValue.ChannelIdAlreadyExistsInOtherAITasks 包含已存在其他AI任务的ChannelId
InvalidParameterValue.ChannelListContainIllegalCharacter ChannelList包含特殊字符
InvalidParameterValue.ChannelListMustBeNotEmpty ChannelList不能为空
InvalidParameterValue.ChannelNumberMustBeLessThanOneThousand ChannelList的数量必须小于1000
InvalidParameterValue.ContainInvalidChannelId 包含无效的ChannelId
InvalidParameterValue.HasDuplicateOperTimeSlot OperTimeSlot值有重复
InvalidParameterValue.InvalidAITaskDesc 无效的AI任务描述信息
InvalidParameterValue.InvalidAITaskName 无效的AI任务名称
InvalidParameterValue.InvalidDetectType 无效的AI分析类型
InvalidParameterValue.InvalidOperTimeSlotFormat 无效的OperTimeSlot格式
InvalidParameterValue.InvalidTemplateTag 无效的TemplateTag
InvalidParameterValue.InvalidTimeInterval 无效的截图频率
InvalidParameterValue.OperTimeSlotContainIllegalCharacter OperTimeSlot包含特殊字符
InvalidParameterValue.OperTimeSlotNumberMustBeLessThanFive OperTimeSlot容量必须小于5
InvalidParameterValue.OperTimeSlotStartMustBeLessThanEnd OperTimeSlot开始时间必须小于结束时间
InvalidParameterValue.TemplateTagMustBeConsistent TemplateTag必须一致