韦尼克API文档

Appearance

基于文件生成PPT ​

适用场景 ​

  • 文件支持MarkDown、Word、PDF、XMind、HTML、FreeMind、TXT
  • 上传文件进行解析，根据解析结果生成PPT
  • 封面默认随机，如需指定封面，可结合接口[AI模板生成]

步骤1：通过文件生成PPT ​

1.说明 ​

  • 接口描述：基于文件进行解析，根据解析的信息生成PPT制作任务，任务生成后，会立即返回一个唯一的任务ID，可以使用该任务ID来查询PPT的生成进度或预览结果
  • 请求地址：https://saas.api.yoo-ai.com/apps/ppt-create-file
  • 请求方式：POST

2.请求参数 ​

Headers请求参数

  • Token需要在韦尼克平台创建相关应用获取
名称类型必选说明示例值
Authorizationstring是Authorization - Bearer TokenBearer Yoo-xxxxxxxxx

Body请求参数

参数类型必须说明示例值
file_urlstring是文件urlhttp://image.yoojober.com/users/chatppt/temp/2024-06/6672a92c87e6f.doc
user_namestring否PPT作者(为空默认值为尤小优)尤小优
cover_idstring否封面ID，默认随机

3.请求示例 ​

json
{
    "file_url":"http://image.yoojober.com/users/chatppt/temp/2024-06/6672a92c87e6f.doc",
    "user_name":"尤小优",
    "cover_id":"FGRW43DF-1"
}

4.响应内容 ​

名称类型参数描述参数示例
codeint状态码
msgstring返回信息
datastring数据体
data.idarray生成任务ID

5.响应示例 ​

json
{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "a3vSWq37DWjcBEc3XuYGNadNZrZWYBjE"
    }
}

步骤2：获取PPT生成结果 ​

1.说明 ​

  • 接口描述：通过之前生成任务的ID即可查询生成任务的进度，并获取对应PPT的预览图片。接口建议进行轮询，通过status参数获取生成状态，通过data.state_description获取进度描述，预览图片逐步生成的

  • 请求地址：https://saas.api.yoo-ai.com/apps/ppt-result

  • 请求方式：GET

2.请求参数 ​

Headers

  • Token需要在韦尼克平台创建相关应用获取
名称类型必选说明示例值
Authorizationstring是Authorization - Bearer TokenBearer Yoo-xxxxxxxxx

Query参数

名称类型必选说明
idstring是任务ID

3.请求示例 ​

json
{
    "id":"acQdp8mesqQUmpQqkVHRMRffWyW7PqsW"
}

4.响应内容 ​

名称类型描述
codeint响应状态码，200表示请求成功
msgstring响应消息，"success"表示请求成功
dataobject包含PPT相关信息的数据对象
idstring任务ID
images_urlarray包含PPT中所有图片的URL和时间戳的数组
images_url.urlstringPPT图片预览地址
images_url.timestringPPT图片生成时间戳
note_statusintPPT备注状态，0-无备注，1-有备注
introducestringPPT的大纲
ppt_titlestringPPT的标题
page_countintPPT的页数
progressint生成进度，100表示已完成
statusint状态(1-进行中 2-已完成 3-生成失败)
first_image_up_atstring第一张图片上传的时间
created_atstringPPT创建的时间
updated_atstringPPT最后更新的时间
state_descriptionstring状态描述，"生成已完成"、"正在生成演示内容"
process_urlstring生成进度的URL
preview_urlstringPPT预览的URL

5.响应示例 ​

json
{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "EvqVxaZtAdugkDbZP3XHs27NTUKHETam",
        "images_url": [
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc2702bb8.png",
                "time": 1734593575
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc28ef1d8.png",
                "time": 1734593577
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc29aa7b8.png",
                "time": 1734593577
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc3a7ef97.png",
                "time": 1734593594
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4482bad.png",
                "time": 1734593604
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc459533b.png",
                "time": 1734593605
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc2b8e268.png",
                "time": 1734593580
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc46d1c17.png",
                "time": 1734593607
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc47da508.png",
                "time": 1734593608
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4914daf.png",
                "time": 1734593609
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc2e61abb.png",
                "time": 1734593582
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc49e9079.png",
                "time": 1734593610
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4b4143d.png",
                "time": 1734593611
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4c1dd44.png",
                "time": 1734593612
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc2f7e7c6.png",
                "time": 1734593583
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4d42ec0.png",
                "time": 1734593613
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4e142a4.png",
                "time": 1734593614
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc4f97409.png",
                "time": 1734593615
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc31c152b.png",
                "time": 1734593586
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc504f8ae.png",
                "time": 1734593616
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc5199932.png",
                "time": 1734593617
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc526eefc.png",
                "time": 1734593618
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc3393f0c.png",
                "time": 1734593587
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc539df8a.png",
                "time": 1734593619
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc54a1049.png",
                "time": 1734593620
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc55a7fda.png",
                "time": 1734593621
            },
            {
                "url": "https://file.static.yoojober.cn/chatppt/20241219/6763cc5608730.png",
                "time": 1734593622
            }
        ],
        "note_status": 0,
        "introduce": "智能办公：ChatPPT的智能生成与辅助功能\r\nChatPPT的基本概念\r\n智能生成与编辑幻灯片\r\nAI大模型的应用\r\n提高工作效率的优势\r\nChatPPT的基本概念\r\n自然语言处理技术\r\n图像识别与提取\r\n机器学习算法应用\r\nChatPPT的基本概念\r\n从内测到公测\r\nPlus版本与插件\r\n重要时间节点\r\nChatPPT的基本概念\r\n企业人士的益处\r\n教育者的实践应用\r\n学生的便捷体验\r\nChatPPT的基本概念\r\n节省时间和精力\r\n专业级幻灯片制作\r\n适应多种场合\r\nChatPPT的基本概念\r\n技术创新与优化\r\n市场需求与产品发展\r\n跨界融合的可能性\r\n",
        "ppt_title": "智能办公：ChatPPT的智能生成与辅助功能",
        "page_count": 27,
        "progress": 100,
        "status": 2,
        "first_image_up_at": "2024-12-19 15:32:55",
        "created_at": "2024-12-19 15:32:07",
        "updated_at": "2024-12-19 15:33:44",
        "state_description": "生成已完成...",
        "process_url": "https://chatppt.test.yoo-ai.com/generateResults?generateID=EvqVxaZtAdugkDbZP3XHs27NTUKHETam",
        "preview_url": "https://chatppt.test.yoo-ai.com/generateResults?generateID=EvqVxaZtAdugkDbZP3XHs27NTUKHETam"
    }
}

步骤3：获取PPT下载地址 ​

1.说明 ​

接口描述获取PPT下载链接
请求地址https://saas.api.yoo-ai.com/apps/ppt-download请求方式GET

2.请求参数 ​

Headers

  • Token需要在韦尼克平台创建相关应用获取
名称类型必选说明示例值
Authorizationstring是Authorization - Bearer TokenBearer Yoo-xxxxxxxxx

query参数

参数类型必须默认值说明
idstring是PPT生成ID
typestring是pptx下载的文件格式

3.请求示例 ​

  • 下载PPTX格式示例：
{
  "id":"BTs3qWzWaFpjRbyz5ZGfAR6SMnSPYyyB",
  "type":"pptx"
}

4.响应内容 ​

名称类型参数描述参数示例
codeint状态码
msgstring描述消息
dataobject数据体
data.download_urlstring下载链接

5.响应示例 ​

json
{
  "code": 200,
  "msg": "success",
  "data":{
      "download_url":"https://download.yoojober.com/chatppt_business/2024-06/86b26b64cb6ebf7565523c9192f467a2.pptx?e=1717675120&token=8_2qFlGEVQZPpFvHdGR6gg2t9A9QZfWT9wwTl92s:cbgbknWpC2QuLzn2zqFDHjifCA4="
      }
}