Create Video Outline Task

Updated: 2026-09-22 18:27:24

API Description

1、通过视频id，创建该视频的视频大纲分析任务，分析完成会以http回调的方式把分析结果回调回去，回调地址暂时请您联系保利威客服人员帮您配置
2、接口支持https协议
3、如果视频没有已发布的字幕，会先使用保利威的智能字幕生成字幕。默认自动发布并应用到该视频；传入 autoApplyEnabled="N" 时，字幕正常生成，但不自动发布，状态为“待校验”
4、autoApplyEnabled 仅控制本次新生成字幕的自动发布行为，不会撤下视频已有的字幕。视频已有可用字幕时，直接使用已有字幕生成大纲

API URL

http://api.polyv.net/vod/v4/video-outline/create

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

URL Parameters

Parameter	Required	Type	Description
appId	true	String	Live streaming appId. You can view your live streaming appId and appSecret in "Cloud VOD" -> "Settings" -> "API Interface"
timestamp	true	Long	Current time in milliseconds, valid within 30 minutes
sign	true	String	Signature, 32-character uppercase MD5 value See MD5 signature generation rules

Body Parameters (JSON)

Parameter	Required	Type	Description
vid	true	String	Video ID
autoApplyEnabled	false	String	Whether to automatically publish and apply subtitles to the video after generation. Values: uppercase Y or N: Y means auto-publish; N means not auto-publish, remaining in "pending verification" state. Default is Y if not provided

Example

https://api.polyv.net/vod/v4/video-outline/create?timestamp=1680148356376&appId=XXXXXXXXXX&sign=7E07C6293779BAC60F95DEC2FDDPB353

Parameters (do not auto-publish after subtitle generation):

{
    "vid": "833u3s271d15dd452bf8393cfd5d4ac6_8",
    "autoApplyEnabled": "N"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
requestId	String	Unique request identifier. If the API call fails, provide this ID to customer support for troubleshooting
success	boolean	true indicates successful API call, false indicates failure
data	Long	Returns the video outline task ID on success, returns null on failure
error	Object	Error description when API call fails See error field description

Error Field Description

Parameter	Type	Description
code	Integer	Error code See return error code list
desc	String	Error description See return error code list

Return Error Code List

code	desc	Description
10002	Signature error	Signature error, please check if the sign parameter is correctly generated
10003	Timestamp expired	Timestamp has expired
20003	application not found.	appId does not exist, please check if the appId is passed correctly

Response Example

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "f813d5d2359743028b6648e54ade1bf1.55.16801596733770029",
  "data": 50,
  "success": true
}

Error Example

Timestamp Expired

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}

Signature Error

{
  "code": 403,
  "status": "error",
  "error": {
    "code": 10002,
    "desc": "签名错误"
  },
  "success": false
}