韦尼克API文档

Appearance

逐步生成PPT ​




适用场景 ​

  • 功能一：生成的PPT大纲和标题提供给用户进行修改或确认

  • 功能二：用户可以通过封面预览选择模板

  • 功能三：可以按照用户修改或者确认过的大纲进行PPT生成

    Tip:

    步骤2非必须步骤，可根据实际场景需要进行选择

步骤1：根据描述生成PPT标题和大纲 ​

1.说明 ​
2.请求参数 ​

Header请求参数

名称类型必选说明
AccessTokenstring是AccessToken
AccessSecretstring是AccessSecret

Body请求参数

  • title、text、theme不能同时为空
  • 参数优先级title>theme>text
参数类型必须默认值示例值
titlestring否PPT标题网络安全大赛
textstring否PPT描述生成一份网络安全PPT
themestring否PPT主题网络安全主题
3.请求示例 ​
json
{
    "title":"网络安全大赛",
    "theme":"网络安全主题",
    "text":"生成一份网络安全PPT"
}
4.响应内容 ​
名称类型说明默认值
titlestringPPT标题
catalogsstring大纲集合
catalogs.catalogstring一级大纲
catalogs.sub_catalogobject二级大纲集合
5.响应示例 ​
json
{
  "code": 200,
  "msg": "success",
  "data": {
    "title": "网络安全大赛",
    "catalogs": [
      {
        "catalog": "技术的特性",
        "sub_catalog": [
          "创新的技术形式",
          "高效率和高可塑性",
          "对现实世界的影响"
        ]
      },
      {
        "catalog": "带来的革命",
        "sub_catalog": [
          "AIGC的应用场景和趋势",
          "赋能生产、释放创造力的影响",
          "对企业创新的推动作用"
        ]
      },
      {
        "catalog": "挑战与机遇",
        "sub_catalog": [
          "AIGC发展中的问题与挑战",
          "创新驱动发展的机遇",
          "适应新时代的策略和措施"
        ]
      },
      {
        "catalog": "人工智能的融合",
        "sub_catalog": [
          "人工智能的互补关系",
          "人工智能在行业应用中的联合发展",
          "和人工智能共同演进的趋势和影响"
        ]
      },
      {
        "catalog": "前景展望",
        "sub_catalog": [
          "未来发展的可能性和方向",
          "数字经济时代的角色和价值",
          "对人类社会发展的影响和意义"
        ]
      }
    ]
  }
}

步骤2：模板封面图预览选择 ​

1.说明 ​

  • 接口描述：通过PPT的标题来生成模板封面信息（支持主题颜色和模板风格的指定），并返回模板封面的ID以及该封面的预览图片URL

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

  • 请求方式：POST

2.请求参数 ​

Header请求参数

名称类型必选说明
AccessTokenstring是AcessToken
AccessSecretstring是AccessSecret

Body请求参数

参数类型必须默认值默认值
titlestringYPPT标题
countstringY模板个数，数量范围(0,4]4
user_namestringN作者尤小优
colorstringN主题颜色，取值为：["紫色","红色","橙色","黄色","绿色","青色","蓝色","粉色"]
stylestringN模板风格， 取值为：["科技","商务","小清新","极简","中国风","可爱卡通"]
3.请求示例 ​
json
{
    "title":"网络安全大赛",
    "count":"2",
    "user_name":"尤小优",
    "color":"绿色",
    "style":"小清新"
}
4.响应内容 ​
名称类型说明默认值
cover_imagestring封面图片url
cover_idstring封面ID(有效期：10min)
colorstring主题色
color_listArray配色列表
5.响应示例 ​
json
{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "cover_image": "http://image.yoojober.com/chatppt/2024-02/db15519f6ec1aeac1faa91d14fe1416c.png",
      "cover_id": "DBgQNU-0",
      "color": "橙色",
      "color_list": [
        "#FFFFFF",
        "#581F00",
        "#FFFFFF",
        "#FFFDFB",
        "#F26C00",
        "#FFBC02",
        "#F88B36",
        "#FB9448",
        "#FE9E5B",
        "#FFA86E",
        "#F26C00",
        "#FFBC02"
      ]
    },
    {
      "cover_image": "http://image.yoojober.com/chatppt/2024-02/89678a9df539cf90856611e22a6f5ba4.png",
      "cover_id": "DBgQNU-1",
      "color": "橙色",
      "color_list": [
        "#FFFFFF",
        "#581F00",
        "#FFFFFF",
        "#FFFDFB",
        "#F26C00",
        "#FFBC02",
        "#F88B36",
        "#FB9448",
        "#FE9E5B",
        "#FFA86E",
        "#F26C00",
        "#FFBC02"
      ]
    },
    {
      "cover_image": "http://image.yoojober.com/chatppt/2024-02/0e93fab3c72bd0540e0d21f676c6e67c.png",
      "cover_id": "DBgQNU-2",
      "color": "橙色",
      "color_list": [
        "#FFFFFF",
        "#581F00",
        "#FFFFFF",
        "#FFFDFB",
        "#F26C00",
        "#FFBC02",
        "#F88B36",
        "#FB9448",
        "#FE9E5B",
        "#FFA86E",
        "#F26C00",
        "#FFBC02"
      ]
    },
    {
      "cover_image": "http://image.yoojober.com/chatppt/2024-02/f0d7aed12cd3845e607803d1630918d1.png",
      "cover_id": "DBgQNU-3",
      "color": "橙色",
      "color_list": [
        "#FFFFFF",
        "#581F00",
        "#FFFFFF",
        "#FFFDFB",
        "#F26C00",
        "#FFBC02",
        "#F88B36",
        "#FB9448",
        "#FE9E5B",
        "#FFA86E",
        "#F26C00",
        "#FFBC02"
      ]
    }
  ]
}

步骤3：申请PPT生成任务 ​

1.说明 ​

  • 接口描述：接收PPT信息（PPT标题、PPT大纲、封面ID），根据这些信息生成PPT制作任务，任务生成后，会立即返回一个唯一的任务ID，可以使用该任务ID来查询PPT的生成进度或预览结果

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

  • 请求方式：POST

2.请求参数 ​

Header请求参数

名称类型必选说明
AccessTokenstring是AccessToken
AccessSecretstring是AccessSecret

Body请求参数

参数类型备注必选默认值
custom_datastring自定义参数Y
cover_idstring封面ID（无指定封面即随机）N

custom_data

参数类型必须说明
titlestringY标题
sub_titlestringN副标题
authorstringN作者
catalogsarray(object)N大纲，具体看catalogs表格，可直接填入步骤1返回的catalogs

catalogs（Array）

参数类型必须说明
catalogstringY一级大纲
sub_catalogarray (string)N该一级大纲下的二级大纲 可以为空，但要尽量保证所有一级大纲下都有或者都没有二级大纲
3.请求示例 ​
json
{
    "cover_id":"Gp7ZFD-0",
    "custom_data":{
        "title":"安全游泳装备选择与使用",
        "sub_title":"安全游泳",
        "author":"作者",
        "catalogs": [
            {
                "catalog": "游泳安全概述",
                "sub_catalog": [
                    "安全游泳的重要性",
                    "基本游泳技能与注意事项"
                ]
            },
            {
                "catalog": "合适装备的选择",
                "sub_catalog": [
                    "选择防水防湿泳装",
                    "潜水与呼吸器的选择"
                ]
            },
            {
                "catalog": "装备的使用方法",
                "sub_catalog": [
                    "设备调试步骤",
                    "日常维护与储存"
                ]
            },
            {
                "catalog": "应对溺水紧急情况",
                "sub_catalog": [
                    "急救包与急救技能",
                    "溺水时的自救与他救"
                ]
            },
            {
                "catalog": "游泳场地安全评估",
                "sub_catalog": [
                    "入场前检查",
                    "避免危险区域"
                ]
            }
        ]
    }
}
4.响应内容 ​
名称类型说明默认值
codeint状态码
msgstring返回状态码
dataobject数据体
data.idstring任务ID
5.响应示例 ​
json
{
    "code": 200,
    "msg": "success",
    "data": {
        "id": "jWVwN5wTHuYv2ZugSXyEJC3YrdT69e9r"
    }
}

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

1.说明 ​
2.请求参数 ​

Header请求参数

名称类型必选说明
AccessTokenstring是AccessToken
AccessSecretstring是AccessSecret

Query参数

名称类型必选说明
idstring是任务ID
3.请求示例 ​
json
{
    "id":"acQdp8mesqQUmpQqkVHRMRffWyW7PqsW"
}
4.响应内容 ​
名称类型描述默认值
codeint状态码
msgstring返回信息
dataobject数据体
data.idstring生成任务ID
data.input_textstring请求任务query
data.images_urlArrayPPT图片信息
data.images_url.urlstringPPT图片预览地址
data.images_url.timestringPPT图片生成时间戳
data.ppt_titlestringPPT标题
data.page_countint总页数
data.progressint生成进度
data.statusint状态(1-进行中 2-已完成 3-生成失败)
data.created_atstring任务开始时间
data.updated_atstring最后更新时间
data.state_descriptionstring进度描述
data.process_urlstringweb加载页面
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",
    }
}