MaaS AIPPT
公共信息
参数 | 描述 | 示例 |
---|---|---|
basePath | 调用mass api的基础路径,包含/v1/ai固定路径 | https://genaiapi.cloudsway.net/v1/ai |
endpointPath | 调用mass api的生成的一段随机路径 | HHNTfinSnyMwnUjs |
AccessKey | 调用mass api的accessKey | RWxxxxxxxx0Gd |
step1 :创建PPT任务
请求方法
POST
请求路径
{basePath}/v1/ai/{endpointPath}/ppt/task
请求header
参数 | 描述 | 示例 |
---|---|---|
Authorization | AccessKey Bearer ${AccessKey} |
Bearer ${AccessKey} |
请求body
字段名 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
type | string | 是 | 任务类型 1-智能生成 | 1 |
title | string | 是 | type=1: 用户输入标题(必填) | 上海近代史 |
返回值
字段名 | 类型 | 描述 | 示例值 |
---|---|---|---|
message | String | 返回信息 | success |
taskId | String | 任务id |
请求示例
curl --location --request POST 'https://genaiapi.cloudsway.net/v1/ai/HHNTfMwnUjs/ppt/task' \
--header 'Authorization: Bearer ${AccessKey}' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--header 'Content-Type: multipart/form-data; boundary=--------------------------687797548226127803760511' \
--form 'type="1"' \
--form 'title="上海近代史"'
返回值
{
"message": "success",
"taskId": "8924627"
}
step2 : 获取模板列表
请求方法
GET
请求路径
{basePath}/v1/ai/{endpointPath}/ppt/export/temples
请求参数
参数名 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
pageNo | int | 是 | 页码 | 1 |
pageSize | int | 是 | 每页显示的任务数 | 5 |
请求header
参数 | 描述 | 示例 |
---|---|---|
Authorization | AccessKey Bearer ${AccessKey} |
Bearer ${AccessKey} |
请求body
无
返回值
字段名 | 类型 | 描述 | 示例值 |
---|---|---|---|
pagination | Object | 分页信息 | { "total": 7779, "current_page": 1, "page_size": 5 } |
pagination.total | int | 总记录数 | 7779 |
pagination.current_page | int | 当前页码 | 1 |
pagination.page_size | int | 每页记录数 | 5 |
list | Array | 模板列表 | [ { "id": 9087, "cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225183752993065.jpeg" }, ... ] |
list.id | int | 模板ID | 9087 |
list.cover_img | String | 封面图片URL | https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225183752993065.jpeg |
示例
请求
curl --location --request GET 'https://genaiapi.cloudsway.net/v1/ai/uBbDleYzdK/ppt/export/temples?pageNo=1&pageSize=5' \
--header 'Authorization: Bearer ${AccessKey}' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Accept: */*' \
--header 'Connection: keep-alive'
返回值
{
"pagination": {
"total": 7779,
"current_page": 1,
"page_size": 5
},
"list": [
{
"id": 9087,
"cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225183752993065.jpeg"
},
{
"id": 9086,
"cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225183443842579.jpeg"
},
{
"id": 9085,
"cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225183240908222.jpeg"
},
{
"id": 9084,
"cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/94/styles/20241225185249105916.jpeg"
},
{
"id": 9083,
"cover_img": "https://genaiapitool.cloudsway.net/aippt/ppt-sop/0/79/styles/20241225182959925460.jpeg"
}
]
}
step3 : 生成作品,并创建导出任务
请求方法
GET
请求路径
{basePath}/v1/ai/{endpointPath}/ppt/export/{taskId}/{templeId}
请求header
参数 | 描述 | 示例 |
---|---|---|
Authorization | AccessKey Bearer ${AccessKey} |
Bearer ${AccessKey} |
请求param
字段名 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
taskId | string | 是 | 任务id | |
templeId | string | 是 | 模板id |
返回值
字段名 | 类型 | 描述 | 示例值 |
---|---|---|---|
exportId | String | 导出任务id | 7396a510-a277-4b6c-b589-069a674508eb |
示例
请求
curl --location --request GET 'https://genaiapi.cloudsway.net/v1/ai/HHNTfwnUjs/ppt/export/8928913/9085' \
--header 'Authorization: Bearer ${AccessKey}' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'content-type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw ''
成功返回值
{
"exportId": "7396a510-a277-4b6c-b589-069a674508eb"
}
失败返回值
生成内容和大纲需要分钟级别时长。如果大纲和内容还在生成中,会返回如下报错
{
"error": {
"code": "1222",
"message": "aippt response error[任务内容错误]"
}
}
生成的大纲和内容有效时长为1小时。超过有效时长后的调用,会返回如下报错
{
"error": {
"code": "1222",
"message": "aippt response error[任务不存在]"
}
}
step4 : 查询导出结果
请求方法
GET
请求路径
{basePath}/v1/ai/{endpointPath}/ppt/export/result/{exportId}
请求参数
无
请求header
参数 | 描述 | 示例 |
---|---|---|
Authorization | AccessKey Bearer ${AccessKey} |
Bearer ${AccessKey} |
请求param
字段名 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
exportId | string | 是 | 导出任务id | |
返回值
字段名 | 类型 | 描述 | 示例值 |
---|---|---|---|
urls | Array | PPT文件下载链接列表 | [ "https://genaiapitool.cloudsway.net/aippt/node-server/aippt/2024-12-26/5203808000l0bg0iz0.pptx?Expires=1735207489&OSSAccessKeyId=LTAI5tEC4LwH9eYcd5ANuTnS&Signature=SCgkfBlXq2fMw8n%2BIkY1%2FyjVcak%3D&response-content-disposition=attachment%3Bfilename%2A%3DUTF-8%27%27temp2591233177458140627AuzreOpenAI%25E8%25BF%2590%25E8%2590%25A5%25E5%25B9%25B3%25E5%258F%25B0.pptx" ] |
示例
请求
curl --location --request GET 'https://genaiapi.cloudsway.net/v1/ai/HHNTfinSnyMwnUjs/ppt/export/result/7396a510-a277-4b6c-b589-069a674508eb' \
--header 'Authorization: Bearer ${AccessKey}' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'content-type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw ''
成功返回值
{
"urls": [
"https://genaiapitool.cloudsway.net/aippt/node-server/aippt/2024-12-26/5203808000l0bg0iz0.pptx?Expires=1735207489&OSSAccessKeyId=LTAI5tEC4LwH9eYcd5ANuTnS&Signature=SCgkfBlXq2fMw8n%2BIkY1%2FyjVcak%3D&response-content-disposition=attachment%3Bfilename%2A%3DUTF-8%27%27temp2591233177458140627AuzreOpenAI%25E8%25BF%2590%25E8%2590%25A5%25E5%25B9%25B3%25E5%258F%25B0.pptx"
]
}
失败返回值
{
"error": {
"code": "1223",
"message": "Current task is in progress, please try again later"
}
}