Appearance
自定义大纲内容生成PPT

适用场景
- 自定义标题、大纲和页面内容
- 自定义页面图片
步骤1:申请PPT生成任务
1.说明
- 接口描述:接收PPT信息(PPT标题、PPT大纲、封面ID、PPT内容),根据这些信息生成PPT制作任务,任务生成后,会立即返回一个唯一的任务ID,可以使用该任务ID来查询PPT的生成进度或预览结果
- 请求地址:https://saas.api.yoo-ai.com/apps/ppt-create
- 请求方式:POST
2.请求参数
Header请求参数
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
AccessToken | string | 是 | AccessToken |
AccessSecret | string | 是 | AccessSecret |
Body请求参数
参数 | 类型 | 备注 | 必选 | 默认值 |
---|---|---|---|---|
custom_data | string | 自定义参数 | Y | |
cover_id | string | 封面ID(无指定封面即随机) | N |
custom_data
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
title | string | Y | 标题 |
sub_title | string | N | 副标题 |
author | string | N | 作者 |
catalogs | array(object) | N | 大纲,具体看catalogs表格 |
contents | array(object) | N | 内容,具体看contents表格 |
catalogs(Array)
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
catalog | string | Y | 一级大纲 |
sub_catalog | array (string) | N | 该一级大纲下的二级大纲 可以为空,但要尽量保证所有一级大纲下都有或者都没有二级大纲 |
contents (array)
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
catalog_index | init | Y | 属于哪个一级大纲,从0开始 |
sub_catalog_index | init | N | 属于一级大纲下的第几个二级大纲,从0开始 如果没有二级大纲可传0或不传 |
content | array (string) array (object key-value) string | Y | 支持3种格式: array (string): 所有文本会以换行连接进行显示(图文)array (object key-value): 会以图示显示;或者key+value由上到下排列图文显示,key会高亮;图示与图文概率随机string: 直接显示一段文本(图文) |
picture | array (string:url) | N | 要显示的图片地址,尽量不要超过3张 |
3.请求示例
json
{
"cover_id":"FGRW43DF-1",
"custom_data": {
"title": "标题",
"sub_title": "副标题",
"author": "作者",
"catalogs": [{
"catalog": "一级大纲1",
"sub_catalog": ["一级大纲1-二级大纲1"]
}, {
"catalog": "一级大纲2",
"sub_catalog": ["一级大纲2-二级大纲1"]
}],
"contents": [{
"catalog_index": 0,
"sub_catalog_index": 0,
"content": ["一级大纲1-二级大纲1-内容1", "一级大纲1-二级大纲1-内容2"]
}, {
"catalog_index": 1,
"sub_catalog_index": 0,
"content": [{
"key": "一级大纲2-二级大纲1-小标题1",
"value": "一级大纲2-二级大纲1-子内容1"
}, {
"key": "一级大纲2-二级大纲1-小标题2",
"value": "一级大纲2-二级大纲1-子内容2"
}, {
"key": "一级大纲2-二级大纲1-小标题3",
"value": "一级大纲2-二级大纲1-子内容3"
}],
"picture": ["https://image.yoojober.com/chatppt_business/2024-02/000114cd07b809cb8c6bb22674e814da.png"]
}]
}
}
4.响应内容
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
code | init | 状态码 | |
msg | string | 返回信息 | |
data | string | 数据体 | |
data.id | string | 生成任务ID |
5.响应示例
json
{
"code": 200,
"msg": "success",
"data": {
"id": "acQdp8mesqQUmpQqkVHRMRffWyW7PqsW"
}
}
步骤2:获取PPT生成结果
1.说明
接口描述:通过之前生成任务的ID即可查询生成任务的进度,并获取对应PPT的预览图片。接口建议进行轮询,通过
status
参数获取生成状态,通过data.state_description
获取进度描述,预览图片逐步生成的请求方式:GET
2.请求参数
Header请求参数
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
AccessToken | string | 是 | AccessToken |
AccessSecret | string | 是 | AccessSecret |
Query参数
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
id | string | 是 | 任务ID |
3.请求示例
json
{
"id":"acQdp8mesqQUmpQqkVHRMRffWyW7PqsW"
}
4.响应内容
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
code | int | 状态码 | |
msg | string | 返回信息 | |
data | object | 数据体 | |
data.id | string | 生成任务ID | |
data.input_text | string | 请求任务query | |
data.images_url | Array | PPT图片信息 | |
data.images_url.url | string | PPT图片预览地址 | |
data.images_url.time | string | PPT图片生成时间戳 | |
data.ppt_title | string | PPT标题 | |
data.page_count | int | 总页数 | |
data.progress | int | 生成进度 | |
data.status | int | 状态(1-进行中 2-已完成 3-生成失败) | |
data.created_at | string | 任务开始时间 | |
data.updated_at | string | 最后更新时间 | |
data.state_description | string | 进度描述 | |
data.process_url | string | web加载页面 |
5.响应示例
json
{
"code": 200,
"msg": "success",
"data": {
"id": "acQdp8mesqQUmpQqkVHRMRffWyW7PqsW",
"input_text": "生成一份网络安全ppt",
"user_client_ip": "192.168.10.1",
"images_url": [
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/7848bc234337d0934cb7229586a1bd53.png",
"time": 1697771030
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/9520959bea2d07d5f854fae1ba4eb655.png",
"time": 1697771030
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/560484f169f101b563c4dc52abe675d9.png",
"time": 1697771031
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/0b18abeccda8b7b3961263653a505aab.png",
"time": 1697771046
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/61c67562f1941f8a3213b597c1e51cb0.png",
"time": 1697771032
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/3a628745afb17cf34ab767fd16eeb498.png",
"time": 1697771040
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/c992895758fad2db14f8aa554a03e3bd.png",
"time": 1697771032
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/87505667281a520e84b0bba8c15c9872.png",
"time": 1697771044
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/0e20c8441c5a367f21d7d8638e6f6fb2.png",
"time": 1697771033
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/71abac6127183ca418f3fdffc7293d63.png",
"time": 1697771042
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/506bafd8b1138249dd5641b918939ed7.png",
"time": 1697771033
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/a5cdb2141c218819b1843f3f236a1f68.png",
"time": 1697771045
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/3fe19acc08e703315630351d6d4128fd.png",
"time": 1697771034
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/7408008b6b69d997d315eaef6382a877.png",
"time": 1697771044
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/357fc06954426a1c4e0ea65569447617.png",
"time": 1697771035
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/d649a2d74dc8d9628fe2c991a907ff57.png",
"time": 1697771042
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/6d738eb507225d210b43dc94242d07f3.png",
"time": 1697771035
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/56bbe4abf173fd632c9d3b2592f4aecb.png",
"time": 1697771044
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/6070a613b0024e728761ede0f693cb5e.png",
"time": 1697771036
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/da844cf3705c9a5d500cff5bca09a8cd.png",
"time": 1697771042
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/72e3ec1b4ffa32633ed0a6b58030e41e.png",
"time": 1697771037
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/754926389c6e39774c305802916f1223.png",
"time": 1697771045
},
{
"url": "https://image.yoojober.com/chatppt_business/2023-10/02738101d6a52dc6a381f4c0acd34b43.png",
"time": 1697771046
}
],
"ppt_title": "网络安全框架",
"page_count": 23,
"progress": 100,
"status": 2,
"created_at": "2023-10-20 11:03:45",
"updated_at": "2023-10-20 11:04:10",
"state_description": "生成已完成...",
"process_url": "https://aigc.yoo-ai.com/generateResults?urlKey=saas&generateID=acQdp8mesqQUmpQqkVHRMRffWyW7PqsW",
}
}