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

Docs Map

文档目录

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

API 接口说明

概览智能PPT API 直连方案的能力地图、接口分组、常规流程与阅读路径。

上一页
企业认证 & API Key 获取方式
下一页
基础接入示例流程

智能PPT API 直连方案适合有研发团队、希望把 PPT 生成与处理能力深度接入现有业务系统的客户。接入时,你不需要先理解所有接口细节,先建立“接口分组”和“常规链路”的整体认知,会更容易完成落地。

能力地图

能力分类代表接口解决什么问题
生成类/apps/ppt-create / /apps/ppt-create-file / /apps/ppt-create-thesis根据主题、文件、论文等内容发起 PPT 生成
结构预处理类/apps/ppt-structure / /apps/ppt-cover先确认目录结构、封面方案,再进入正式生成
结果查询类/apps/ppt-result查询任务进度、状态、预览和交付前置信息
交付类/apps/ppt-download / /apps/ppt-editor下载 PPT 或进入在线编辑器
增强类演讲稿、插页、动画、字体、套版等接口在已有 PPT 基础上继续增强和编辑
公共服务类余额查询、状态码统一处理配额、状态与异常返回

接入前准备

所有 API 调用前,建议先完成以下准备:

  1. 阅读企业认证 & API Key 获取方式。
  2. 确认服务端能稳定携带 Authorization: Bearer {token}。
  3. 在业务系统中预留任务 id 的持久化存储。

接口分组

1. 导读与流程

这一组文档用于建立接入认知,帮助你先跑通最短闭环:

  • 基础接入示例流程:先理解标准链路如何跑通。
  • 异步接口说明:理解为什么返回的是任务 id。
  • 发起生成任务:判断不同场景该从哪个生成入口开始。
  • 二次处理与辅助能力:理解生成完成后还能做什么。

2. 生成接口

这一组接口负责“从 0 到 1”发起 PPT 任务:

场景文档对应能力
一句话主题、长文本生成输入文字主题生成最常见主入口
上传 PDF / Word 等文件生成上传文件生成(PDF / Word)适合已有材料
学术答辩生成答辩论文生成适合论文答辩场景
先确认大纲再生成自定义大纲生成适合企业审核场景
Markdown 结构直接生成Markdown 大纲生成适合内容结构已明确的场景
企业品牌模板生成企业模板生成适合品牌统一交付

3. 扩展生成接口

这一组更适合在主流程跑通后再接入:

  • 更多生成方案
  • AI 标题大纲生成
  • 模板封面生成
  • 绘图 PPT 生成

4. 结果与交付接口

这组接口几乎是所有生成链路的必经环节:

文档接口作用
任务状态查询与结果获取/apps/ppt-result查询进度、状态、预览和结果
导出与下载/apps/ppt-download获取下载地址
打开编辑器/apps/ppt-editor获取编辑器地址
余额查询 / 状态码通用接口统一处理配额和异常返回

5. 增强接口

这组接口用于“已有 PPT 之后”的增强处理:

  • 更换模板 / 主题色
  • 添加 / 生成演讲稿
  • 插入单页 / 增加动画
  • 更换字体

常规接入流程

大多数 API 直连项目都遵循下面这条标准链路:

选择一个生成入口
-> 创建任务并返回 id
-> 查询 /apps/ppt-result
-> 任务完成后下载 PPT 或进入编辑器
-> 按需继续做演讲稿、插页、动画、字体等增强处理

如果你只想先跑通一条最短闭环,推荐从基础接入示例流程开始。

常见业务组合

快速主题生成

输入文字主题生成
-> 查询任务结果
-> 下载 PPT

文件材料生成

上传文件生成
-> 查询任务结果
-> 下载或进入编辑器

企业审核式生成

AI 标题大纲生成 / 自定义大纲生成
-> 人工确认结构
-> 正式创建 PPT
-> 查询结果并交付

生成后继续编辑

先完成生成主流程
-> 打开编辑器
-> 添加演讲稿 / 插入单页 / 调整样式

接入建议

  • 第一次联调时,不要同时接全部接口,先跑通一条主流程。
  • 先完成“创建 -> 查询 -> 下载”的最短闭环,再接编辑器和增强能力。
  • 业务系统中一定要保存任务 id,不要把创建成功直接当成生成完成。
  • 如果项目需要人工审核内容结构,优先考虑先出大纲再正式生成。

推荐阅读顺序

  1. 先看本页,了解接口分组和整体结构。
  2. 再看基础接入示例流程,跑通标准接入链路。
  3. 如果不理解任务模式,再看异步接口说明。
  4. 按场景进入对应生成接口文档。
  5. 主流程稳定后,再评估编辑器与增强接口。