韦尼克API文档

Appearance

按格式大纲生成 PPT ​

说明 ​

该步骤不支持选择模板，若需生成模板预览，续调用请求生成 PPT 封面图片接口

1.请求生成 PPT 文档 ​

（1）说明 ​

（2）请求参数 ​

Headers（通过在韦尼克平台创建应用获取）

参数名类型描述示例值
AuthorizationstringAuthorization - Bearer TokenBearer Yoo-xxxxxxxxx

Body 参数

text、custom_data 二选一必填，本功能选 custom_data

参数名类型必填描述默认值
textstringY请求生成 PPT 文本
custom_dataobjectY自定义结构，包含标题、副标题、作者、大纲、内容等信息
custom_data.titlestringY标题
custom_data.sub_titlestringN副标题
custom_data.authorstringN作者尤小优
custom_data.catalogsarrayY大纲
custom_data.catalogs.catalogstringY一级大纲
custom_data.catalogs.sub_catalogarray (string)N该一级大纲下的二级大纲 可以为空，但要尽量保证所有一级大纲下都有或者都没有二级大纲
custom_data.contentsarrayY内容
custom_data.contents.catalog_indexintY属于哪个一级大纲，从 0 开始
custom_data.contents.sub_catalog_indexintN属于一级大纲下的第几个二级大纲，从 0 开始 如果没有二级大纲可传 0 或不传
custom_data.contents.contentarray (string) array (object key-value) stringY支持 3 种格式： array (string): 所有文本会以换行连接进行显示（图文）array (object key-value): 会以图示显示；或者 key+value 由上到下排列图文显示，key 会高亮；图示与图文概率随机 string: 直接显示一段文本（图文）
custom_data.contents.picturearray (string:url)N要显示的图片地址，尽量不要超过 3 张
complexintNPPT 复杂度（1-简单 2-中等 3-复杂）1
font_namestringN字体
languagestringNen-US （英文），zh-TW（繁体）
colorstringN颜色
user_namestringN作者名尤小优
over_idstringN封面 ID（通过模版接口获取）

（3）请求示例 ​

仅展示使用一句话描述生成 PPT 文档示例

json
{
  "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"
          }
        ]
      }
    ]
  },
  "complex": 3,
  "font_name": "黑体",
  "language": "en-US",
  "color": "蓝色",
  "user_name": "张三"
}

（4）响应内容 ​

参数名类型描述
codeinteger状态码
msgstring响应消息
dataobject数据体
data.idstring任务 ID

（5）响应示例 ​

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

2.获取 PPT 生成结果 ​

（1）说明 ​

（2）请求参数 ​

Headers

参数名类型描述示例值
AuthorizationstringAuthorization - Bearer TokenBearer Yoo-xxxxxxxxx

Query 参数

参数名类型必填描述默认值
idstringY任务 ID

（3）请求示例 ​

json
{
  "id": "fYD32vr5wS8QzN7kjzRasQuanFhwqtMj"
}

（4）响应内容 ​

参数名类型描述
codeinteger状态码
msgstring响应消息
dataobject数据体
data.idstring任务 ID
data.images_urlarrayPPT 中所有的图片 URL 和时间戳的数组
data.images_url.urlstringPPT 图片的 url
data.images_url.timestring时间戳
data.note_statusintPPT 备注状态（0-无备注，1-有备注）
data.introducestringPPT 的大纲
data.ppt_titlestringPPT 标题
data.page_countintPPT 的页数
data.progressint生成进度，100 表示已完成
data.statusint状态(1-进行中 2-已完成 3-生成失败)
data.first_image_up_atstring第一张图片上传的时间
data.created_atstringPPT 创建的时间
data.updated_atstringPPT 最后更新的时间
data.state_descriptionstring状态描述（"生成已完成"、"正在生成演示内容"）
data.process_urlstring生成进度的 URL
data.preview_urlstringPPT 预览的 URL

（5）响应示例 ​

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "id": "Hxp9YeEEBc98xm78xsTWcWKzE2wMSBNT",
    "images_url": [
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/orz6mlwllh6dp.png",
        "time": 1741769433
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/7628cpixsa09b.png",
        "time": 1741769434
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/j7l7jw3ttk0ny.png",
        "time": 1741769435
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/ru4aiq31zs0ds.png",
        "time": 1741769445
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/xb1k9p6sfdzlf.png",
        "time": 1741769436
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/tb8einegio0jh.png",
        "time": 1741769455
      },
      {
        "url": "https://file.static.yoojober.cn/chatppt/20250312/jhclpoeh3n1ks.png",
        "time": 1741769459
      }
    ],
    "note_status": 0,
    "introduce": "标题\r\n一级大纲1\r\n一级大纲1-二级大纲1\r\n一级大纲1\r\n一级大纲2-二级大纲1\r\n",
    "ppt_title": "标题",
    "page_count": 7,
    "progress": 100,
    "status": 2,
    "first_image_up_at": "2025-03-12 16:50:33",
    "created_at": "2025-03-12 16:50:23",
    "updated_at": "2025-03-12 16:51:03",
    "state_description": "生成已完成...",
    "process_url": "https://chatppt.yoo-ai.com/generateResults?generateID=Hxp9YeEEBc98xm78xsTWcWKzE2wMSBNT",
    "preview_url": "https://chatppt.yoo-ai.com/generateResults?generateID=Hxp9YeEEBc98xm78xsTWcWKzE2wMSBNT"
  }
}

3.生成 PPT 下载地址 ​

（1）说明 ​

（2）请求参数 ​

Headers

参数名类型描述示例值
AuthorizationstringAuthorization - Bearer TokenBearer Yoo-xxxxxxxxx

Query 参数

参数名类型必填描述默认值
idstringY任务 ID

（3）请求示例 ​

json
{
  "id": "fYD32vr5wS8QzN7kjzRasQuanFhwqtMj"
}

（4）响应内容 ​

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

（5）响应示例 ​

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "download_url": "https://yoo-web-public.gz.bcebos.com/chatppt/20250311/0zi59rxjwfvpw.pptx?authorization=bce-auth-v1%2FALTAK7YW57hmnPzhWsz3GT3DUV%2F2025-03-12T09%3A18%3A10Z%2F3600%2F%2F86ed0b0caf5c87eee77797c2077603149264fb3c1db588b18138c0d96454ef9d"
  }
}