韦尼克 Logo
韦尼克平台
AI Document Platform
⌘K
开发文档API 调试台AI接入助手

Docs Map

文档目录

产品介绍选择接入方式先读企业认证 & API Key 获取方式共用
API 接口说明先看基础接入示例流程先看异步接口说明发起生成任务二次处理与辅助能力
首页基础接入示例流程

基础接入示例流程

说明智能PPT API 直连方案的标准接入链路,以及创建、查询、下载、编辑之间的调用关系。

上一页
API 接口说明
下一页
异步接口说明

这一页是智能PPT API 直连方案的主流程总览。只要你接的是生成类接口,最终都要回到这条标准链路:

创建任务 -> 拿到任务 id -> 查询结果 -> 下载 PPT 或进入编辑器 -> 继续增强处理

最短闭环

步骤接口作用
1创建类接口,如 /apps/ppt-create发起生成任务,返回任务 id
2/apps/ppt-result查询任务进度和结果
3A/apps/ppt-download获取下载地址
3B/apps/ppt-editor获取编辑器地址

流程图

提交生成请求
-> 返回 data.id
-> 轮询 /apps/ppt-result?id={id}
   -> status=1: 继续等待
   -> status=2: 已完成,可下载或进入编辑器
   -> status=3: 失败,提示重试

步骤 1:创建任务

创建入口可以很多,但创建成功后都会返回同一种关键结果:

{
  "code": 200,
  "msg": "success",
  "data": {
    "id": "任务ID"
  }
}

data.id 是整条链路的主键,后续查询、下载、进入编辑器和增强处理都会继续使用它。

常见创建入口示例:

  • 文本主题生成:POST /apps/ppt-create
  • 文件生成:POST /apps/ppt-create-file
  • 论文答辩生成:POST /apps/ppt-create-thesis
  • 企业模板生成:POST /apps/ppt-company-create

如果你要比较不同生成入口的适用场景,继续看发起生成任务。

步骤 2:查询任务状态

创建成功后,统一通过以下接口查询任务状态:

GET /apps/ppt-result?id={id}

建议轮询频率如下:

场景建议频率
普通业务系统每 3 秒一次
需要更实时的前台展示每 2 秒一次
服务端批处理每 5 秒一次

重点关注以下字段:

字段用途
status判断进行中、完成、失败
progress展示进度百分比
state_description向用户解释当前阶段
preview_url预览链接
process_url进度页链接

状态处理建议:

status含义建议处理
1进行中继续轮询
2已完成开放下载和编辑
3失败提示失败并允许重试

如果你只想先建立“为什么要轮询、id 有什么用”的认知,继续看异步接口说明。

步骤 3:完成后交付

下载 PPT

GET /apps/ppt-download?id={id}

接口返回 download_url 后即可发起文件下载。

进入在线编辑器

POST /apps/ppt-editor

请求示例:

{
  "id": "任务ID",
  "expire": 86400
}

当 PPT 尚未生成完成时,编辑器接口可能返回:

{
  "code": 204,
  "msg": "请等待PPT生成完成...",
  "data": {}
}

这通常表示“尚未完成”,不应当成异常。建议继续查询结果接口,待状态完成后再次获取编辑器地址。

特殊模式:report=true

如需尽早进入编辑器链路,可在创建接口中传入:

{
  "text": "生成一份新品发布会PPT",
  "report": true
}

该模式的特点如下:

  • 更适合“生成过程中进入编辑器”的交付方式
  • 结果接口的阅读方式会和标准图片结果有所不同
  • 不能再把图片数组当作唯一结果来源

典型链路

文本主题生成

/apps/ppt-create
-> /apps/ppt-result
-> /apps/ppt-download 或 /apps/ppt-editor

文件或论文生成

/apps/ppt-create-file 或 /apps/ppt-create-thesis
-> /apps/ppt-result
-> /apps/ppt-download 或 /apps/ppt-editor

生成完成后的增强处理

先完成主流程
-> 拿到已有任务 id
-> 调用增强接口
-> 如触发新处理,再继续查询 /apps/ppt-result

增强接口的职责和前置依赖详见二次处理与辅助能力。

前端文案建议

技术状态推荐展示文案
创建任务成功已开始生成 PPT
status = 1正在生成,请稍候
status = 2生成完成,可下载或继续编辑
status = 3生成失败,请重试

注意事项

  1. 创建任务成功不等于 PPT 已可下载。
  2. 结果是否完成,以 /apps/ppt-result 为准,不要只看创建接口返回成功。
  3. 编辑器返回 204 通常表示“尚未完成”,不是接口异常。
  4. 所有后续能力都依赖任务 id,务必在业务系统中持久化保存。