Asynchronous Upload of PPT for Video Creation

Updated: 2026-06-12 10:49:48

Interface Description

1、异步上传制课ppt, 调用接口后，直接返回结果，异步获取ppt并上传
2、可通过回调或调用查询视频创作任务接口获取上传状态及转码解析结果, 转码完成后即可将该ppt用于视频创作
3、接口支持https协议
4、支持200M以内ppt大文件上传

Interface URL

https://api.polyv.net/live/v4/ai/video-produce/ppt/async-upload

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

URL Request Parameter Description (for Signing)

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys]
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 for generating the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data.` See signature generation rules
url	true	String	PPT file URL address (only supports ppt and pptx document links, maximum file size 200MB)
docName	false	String	Custom PPT file name (if not provided, the file name from the URL address is used)
type	false	String	Conversion type. Default is normal if not provided. Values: `common` - Normal `animate` - Animated PPT
callbackUrl	false	String	Callback URL. After transcoding is complete, the result will be notified to this address.
childUserId	false	String	Live streaming sub-account user ID, used to isolate PPT data between sub-accounts

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure.
status	String	Response result. Determined by business logic. Returns "success" on success, "error" on failure.
success	Boolean	Response result. Determined by business logic. Returns true on success, false on failure.
data	Object	Channel details returned on successful response. See data field description
error	Object	Error information when status code is non-200. See Error field description
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic.

Data Parameter Description

Parameter	Type	Description
fileId	String	File ID. Note: POLYV will not create duplicate PPT transcoding and parsing tasks for identical PPT files. If you upload the same PPT repeatedly, the returned fileId will be the same. (Use the Query PPT for Video Creation interface to get the PPT document status.)

Response Example

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "e90aba2c69a24bab894c7f708b853b75.72.17161066775207261",
  "data": {
    "fileId": "22d1a1586dc04382685996bc227bfb44c560fac50fpptVideocommon"
  },
  "success": true
}

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.

Callback Description

Real-time callback for PPT upload failure or conversion result, allowing timely notification of upload and conversion task results.

Principle

Sends a GET request to the user's server via the HTTP interface (the set callbackUrl) to push the merge result to the user's server.

Example

Example as follows: http://abc.com/test.do?status=normal&timestamp=1603506240000&fileId=xxx&sign=xxdxxxxx

Parameter	Type	Description
status	String	File conversion status ("normal": normal, "failConvert": PPT conversion failed, "failUpload": PPT upload failed)
fileId	String	File ID, returned on success.
timestamp	Long	13-digit millisecond timestamp.
sign	String	Encrypted string for verification. Generation rule: md5(fileId+timestamp)

Live Streaming Server API