查询PPT作品信息
接口说明
接入说明:
当前接口为 HTTP-SSE 协议。
由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持 Java、Python 版本的 sdk)请参考 PPT 生成最佳实践文档。
其中获取 Java 异步 SDK 的最新版本: 请点击链接获取。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
否 |
业务空间 ID |
llm-az2gglxxxx |
| PptArtifactId |
integer |
否 |
PPT 作品 ID |
5232136 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
xxxxx |
| Success |
boolean |
此次请求是否成功 |
true |
| Code |
string |
错误码 |
DataNotExists |
| Message |
string |
错误消息 |
错误消息 |
| HttpStatusCode |
integer |
http 错误码 |
400 |
| Data |
object |
任务响应对象 |
|
| CreateTime |
string |
更新日期 |
2024-11-25 11:40:50 |
| Id |
integer |
文档唯一标识 |
10 |
| Title |
string |
标题 |
内容标题 |
| UpdateTime |
string |
更新日期 |
2024-11-25 11:40:50 |
| FileKey |
string |
后端业务存储本次规则库解析结果的路径。 |
oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx |
| FileAttr |
object |
文件属性 |
|
| FileName |
string |
文件名称 |
xxx.pptx |
| Width |
integer |
宽度 |
800 |
| TmpUrl |
string |
视频文件临时访问 URL。1 小时过期 |
http://www.example.com/xxx.pptx |
| Height |
integer |
高度 |
600 |
示例
正常返回示例
JSON格式
{
"RequestId": "xxxxx",
"Success": true,
"Code": "DataNotExists",
"Message": "错误消息",
"HttpStatusCode": 400,
"Data": {
"CreateTime": "2024-11-25 11:40:50",
"Id": 10,
"Title": "内容标题\n\n",
"UpdateTime": "2024-11-25 11:40:50",
"FileKey": "oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx",
"FileAttr": {
"FileName": "xxx.pptx",
"Width": 800,
"TmpUrl": "http://www.example.com/xxx.pptx",
"Height": 600
}
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。