API 快速开始 ​

拼装版（API 版本）适合接入方自行实现前端页面，并通过 API 调用 AiPPT 的大纲生成、模板、作品和下载能力。

基本流程 ​

  1. 获取认证 token：参考 鉴权。
  2. 创建任务：调用 任务创建，获得 taskId。
  3. 获取生成内容：根据任务类型调用对应内容接口。
  4. 获取大纲数据结构：调用 获取大纲数据结构，用于合成前的大纲树或内容结构处理。
  5. 生成或管理 PPT 作品：调用 作品 相关接口。
  6. 导出大纲或完整内容：按需调用 导出大纲、完整内容。

接入前检查 ​

检查项要求
鉴权已获取 token，并在 API 请求 Header 中传入 x-api-key、x-token 和 x-channel；无渠道区分时 x-channel 传空值
用户标识已确定接入方用户唯一标识，后续任务、作品和额度查询保持一致
生成方式已确认使用标题、Word、参考文档、普通文件、URL、联网生成或单页生成
异步处理已准备处理流式响应、轮询查询和生成失败重试
作品处理已确认是否需要作品生成、作品导出、作品列表或回收站能力

常见链路 ​

生成方式对照 ​

生成方式内容接口返回形态下一步
标题生成智能生成大纲流式返回，内容通过 ticket 查询获取大纲数据结构或生成作品
Word 导入上传 Word流式返回 Markdown 内容获取大纲数据结构或生成作品
参考文档导入上传参考文档流式返回 Markdown 内容获取大纲数据结构或生成作品
普通文件导入上传普通文件直接返回 Markdown 内容获取大纲数据结构或生成作品
URL 导入导入 URL 链接流式返回 Markdown 内容获取大纲数据结构或生成作品
联网生成联网智能生成流式返回 Markdown 内容获取大纲数据结构或生成作品
单页生成单页生成流式返回单页内容合并到当前任务内容或继续生成作品

标题生成 PPT ​

  1. 调用 任务创建，type=1，传入标题。
  2. 调用 智能生成 获取大纲。
  3. 调用 智能生成 生成完整内容。
  4. 调用 智能生成 查询内容生成结果。
  5. 调用 获取大纲数据结构 获取合成前的大纲数据结构。
  6. 调用 作品 生成或管理 PPT 作品。

文档导入生成 PPT ​

  1. 调用 任务创建，按文档类型传入解析后的内容。
  2. 根据文档类型调用 上传 Word、上传参考文档 或 上传普通文件 获取生成内容。
  3. 后续调用 获取大纲数据结构 处理合成前数据，或调用 作品 生成作品。

链接导入生成 PPT ​

  1. 调用 任务创建，创建链接导入任务。
  2. 调用 导入 URL 链接 获取生成内容。
  3. 后续调用 获取大纲数据结构 处理合成前数据，或调用 作品 生成作品。

异步任务处理 ​

拼装版 API 中的生成链路通常不是一次请求直接返回最终 PPT。接入方需要按以下方式处理：

  1. 创建任务后保存 taskId，后续内容生成、结果查询和作品处理都围绕该任务继续。
  2. 接收流式内容时，按 API 公共约定 解析 event:message 和 event:close。
  3. 遇到需要查询结果的接口时，按接口返回的任务标识或查询凭证继续轮询，直到获得完成、失败或超时状态。
  4. 生成失败时，不要复用已失败的中间结果继续合成；应回到对应生成步骤重新提交。

生成后处理 ​

生成内容不是业务闭环的终点。接入方通常还需要根据业务目标选择后续处理方式：

目标推荐接口说明
获取可用于 PPT 合成的大纲树获取大纲数据结构位于生成内容之后、作品生成之前
生成 PPT 作品并管理作品作品覆盖作品生成、列表、详情、导出、重命名和删除
导出大纲或完整内容文件导出大纲、完整内容导出 Markdown/内容文件，不等同于 PPT 作品导出

如果接入方最终要得到 PPTX，通常先生成作品，再使用 作品导出 和 作品导出结果。

辅助能力 ​

除主生成链路外，接入方还可以按业务需要接入以下辅助能力：

目标推荐接口说明
让用户选择模板模板获取系统模板、企业模板和筛选项
提供生成主题建议预置词获取平台预置的生成主题和内容示例
管理已删除作品回收站查询、还原或彻底删除已删除作品
查询用户额度消耗获取用户大纲次数用于额度、统计或运营展示

请求示例 ​

bash
curl --location --request POST 'https://co.aippt.cn/api/ai/chat/v2/task' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel: ' \
--header 'x-token: {{token}}' \
--form 'title="毕业季"' \
--form 'type="1"'

下一步 ​

  • 查看 API 公共约定，了解域名、Header、占位符和响应格式。
  • 查看 任务创建，开始创建第一个任务。
  • 查看 作品，了解作品生成、导出、重命名和删除。