Create Staging Video Outline

Updated: 2026-01-16 08:58:18

Interface Description

Used to create an AI outline task for staging videos
Optionally enable knowledge quiz, review-before-publish, and auto-marking for playback
Interface supports HTTPS protocol

Interface URL

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS; HTTPS is recommended for security
API calls are rate-limited; see details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId see Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` see Signature Generation Rules
fileId	true	String	Staging file ID
aiKnowledgeQuizEnabled	false	String	Knowledge quiz toggle, Y: enable, N: disable, default N
aiSummaryAuditEnabled	false	String	Outline review-before-publish toggle, Y: enable, N: disable, default N
syncToPlaybackDotEnabled	false	String	Auto-marking for playback toggle, Y: enable, N: disable, default N

Example

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create?appId=frlr1zazn3&sign=79767F7E02132E1904C304E4F225CC2A&timestamp=1634783281943

Request Body Example

{
    "fileId": "recordFileId123",
    "aiKnowledgeQuizEnabled": "Y",
    "aiSummaryAuditEnabled": "N",
    "syncToPlaybackDotEnabled": "N"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic; returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request, for troubleshooting and debugging only; should not be tied to business logic
error	Object	Error information when status code is not 200 see Error Field Description
data	Object	see Data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

Data Parameter Description

Returns an empty object on successful request

Java Request Example

For quick integration of the base code, download the related dependency source code: Click to download source code. After downloading, add it to your own source project. The test cases HttpUtil.java and LiveSignUtil.java are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 创建暂存视频大纲
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createRecordFileOutlineTest() throws IOException, NoSuchAlgorithmException {
    //公共参数，填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/create";
    String fileId = "recordFileId123";

    //请求body参数
    Map<String, Object> requestBody = new HashMap<>();
    requestBody.put("fileId", fileId);
    requestBody.put("aiKnowledgeQuizEnabled", "Y");
    requestBody.put("aiSummaryAuditEnabled", "N");
    requestBody.put("syncToPlaybackDotEnabled", "N");

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.postJson(url, requestMap, JsonUtil.toJson(requestBody));
    log.info("测试创建暂存视频大纲成功：{}", response);
    //do somethings
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "b38bdd97dc404213a2436e7a086b9db9.82.16347832877195279",
    "data": {},
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360832149273615",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API