Get Staged Video Outline

Updated: 2025-12-26 09:01:17

Interface Description

Query the AI outline and quiz content (if generated) based on the channel ID and staged file ID.
The interface supports the HTTPS protocol.

Interface URL

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/get-by-fileId

Online API Call

Request Method

GET

Interface Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 never be saved or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain responses.` See details in Signature Generation Rules
channelId	true	Integer	Channel ID
fileId	true	String	Staged file ID

Example

http://api.polyv.net/live/v4/channel/record-file/subtitle/outline/get-by-fileId?appId=frlr1zazn3&sign=79767F7E02132E1904C304E4F225CC2A&timestamp=1634783281943&channelId=100001&fileId=recordFileId123

Response Parameter Description

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

Error Parameter Description

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

Data Parameter Description

Parameter	Type	Description
status	String	Outline generation status: init - initializing, srt_processing - subtitle generating, outline_processing - outline generating, audit - pending review, success - completed, fail - generation failed
outline	Object	Outline JSON, empty if not generated or generation failed
question	Object	Quiz JSON, empty if not generated or generation failed
failReason	String	Reason for failure (returned when status=fail)

Java Request Example

For quick integration of the basic code, download the related dependency source code: Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download 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 getRecordFileOutlineTest() 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/get-by-fileId";
    String channelId = "100001";
    String fileId = "recordFileId123";

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

    String response = HttpUtil.get(url, requestMap);
    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": {
        "status": "success",
        "outline": {
            "title": "直播回放大纲",
            "items": [
                {
                    "title": "开场介绍",
                    "startTime": 0,
                    "endTime": 120
                }
            ]
        },
        "question": [
            {
                "question": "本场主题是什么？",
                "answer": "产品发布",
                "startTime": 60
            }
        ]
    },
    "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