AI自动生成PPT文档 aippt的API介绍文档

原创

wx664ae87453866 2024-06-06 10:43:51 ©著作权

文章标签 powerpoint 请求参数 API 5e 文章分类 Html/CSS 前端开发

©著作权归作者所有：来自51CTO博客作者wx664ae87453866的原创作品，请联系作者获取转载授权，否则将追究法律责任

产品介绍

能力介绍

AiPPT 是一款智能生成演示幻灯片的在线工具。专业设计团队打造海量模板资源，输入标题即可轻松生成完整的PPT。同时 AiPPT 支持导入多格式文档一键生成 PPT，让 PPT 创作更加高效。聚焦于内容，确保每张幻灯片都以清晰的主题和关键信息为核心，简洁明了地表达您的观点。提供丰富多样的模板和布局样式，以灵活适应不同内容的需要。支持一键切换模板和配色方案，让您的 PPT 瞬间焕然一新。
开放AiPPT底层能力，提供多种接入版本，可满足多种业务使用形式；专属客户服务，快速对接使用，产品能力同步迭代；一次接入，长效无忧。

一键生成

输入标题即可直接生成 PPT

文档导入

支持 docx、xmind、freemind、markdown 文件导入直接生成 PPT

思维导图

支持思维导图在线预览、编辑、下载为文本或图片格式

在线编辑

丰富的在线编辑能力，支持文本、图片、表格、图表、大纲等编辑调整；海量模板支持一键替换

在线演示

支持 PPT 作品的在线演示

PPT下载

支持将在线作品保存到本地, 可选格式包含: PPT、PDF、PNG、JPEG

版本介绍

API版本接入

将AiPPT产品能力以API接口形式进行提供接入，可最大化匹配您的产品业务流程与交互，可根据产品需要实现自主功能界面

UI版本接入

将AiPPT产品能力以iframe嵌入形式集成到您的产品中，最大化保留AIPPT产品功能与交互设计，实现更加快速低成本的产品上线

JS版本接入（不再维护）

该版本后续不再升级迭代，建议使用API版本接入

接入指引

1. 提交申请

在开放平台首页点击【立即申请】后，填写接入申请信息
信息提交后，工作人员将在2个工作日内与您取得联系

AI自动生成PPT文档 aippt的API介绍文档_API

2.开通开放平台账号

由工作人员为您开启企业账号后，可登录开放平台进行企业认证
提交认证后，工作人员会尽快为您开放权限

AI自动生成PPT文档 aippt的API介绍文档_powerpoint_02

3.获取接入的`APP Key`和`Secret Key`

企业认证成功后，可在开放平台的工作台查看到接入所需的App Key和Secret Key

AI自动生成PPT文档 aippt的API介绍文档_API_03

4.技术接入，能力集成

完成以上步骤，您就可以根据文档进行能力对应集成的接入
集成过程中请确保准确配置 App ID

获取鉴权

说明

采用 AK(api key)/SK(api secret) 签名认证, 开通 AP I账号得到 AK、SK

AK/SK 签名认证流程

构造规范请求: 将待发送的请求内容按照与API服务端约定的规则组装，确保客户端签名、API服务端认证时使用的请求内容一致。
创建待签字符串: 使用规范请求和其他信息创建待签字符串。
计算签名: 使用AK/SK和待签字符串计算签名。
信息上传: 将生成的签名信息作为请求消息头添加到 HTTP 请求中。

1.构造规范请求

使用AK/SK方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与API服务端使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。

HttpRequestMethod：HTTP 请求方法，如 GET、POST。
ApiUri：请求资源路径，以 "/" 开头，并以 "/" 结尾，如果URI路径不以 "/" 结尾，则在尾部添加 "/" 如：/api/grant/code 需要变为 /api/grant/code/
Timestamp: 请求的时间戳，单位秒。

2.创建待签字符串

伪代码: 各个参数之间用 "@" 隔开 stringToSign = HttpRequestMethod + "@" + ApiUri + "@" + Timestamp。

示例(token): stringToSign = GET@/api/grant/token/@1696821929
示例(code): stringToSign = GET@/api/grant/code/@1696821929

3.计算签名

使用SK和创建好的待签字符串进行Hmac sha1 计算得到签名值，然后再做 base64_encode，计算得到最终签名值。加密结果如：MipstvjcmFP20jd3WUCYvhYvzVE=

4.信息上传

请求示例
GET https://co.aippt.cn/api/grant/code?uid=1&channel=
Header:  x-api-key:645e1231d1ba5
Header:  x-timestamp:1696821929
Header:  x-signature:ACsZ2tral4zHq5opRIAgsxC1nOg=

获取认证TOKEN

业务流程图

AI自动生成PPT文档 aippt的API介绍文档_5e_04

描述

接口描述	token有效期目前是30天，建议接入方服务端缓存并跟踪 x-token 的过期时间并及时更新，避免频繁调用。 token 颗粒度是用户级别的，即：接入方下的每一个用户的 x-token 都不同。
接口地址	/api/grant/token	请求方式	GET
权限校验	是	请求参数	json

请求参数

x-api-key	header	string	是	创建账号时生成的api key
x-timestamp	header	string	是	请求时间戳，与计算签名使用的时间戳保持一致
x-signature	header	string	是	根据计算签名得到的最终签名值
uid	query	string	是	第三方用户唯一标识
channel	query	string	是	渠道标识，存在则进行传递，没有传空字符串

请求示例

curl --location 'https://co.aippt.cn/api/grant/token?uid=1&channel=xxx' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-timestamp: 1696821929' \
--header 'x-sign: Uf1UYWp45y0deQ9/eS1CCDQXqJ8='

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	api_key	string	创建账号时生成的api key
	uid	string	第三方用户唯一标识
	token	string	token
	time_expire	number	token有效期，30天

响应示例

{
    "code": 0,
    "data": {
        "api_key": "xxxx",
        "uid": "123",
        "token": "xxxx",
        "time_expire": 2592000
    },
    "msg": "ok"
}

获取认证Code

业务流程图

AI自动生成PPT文档 aippt的API介绍文档_请求参数_05

描述

接口描述	第三方用户在前端打开Iframe时，需要通过第三方服务端调用AIPPT API接口申请访问的授权码（x-code）。第三方拿到授权码（x-code）后，需要把授权码（x-code）传入 AIPPT JSSDK
接口地址	/api/grant/code	请求方式	GET
权限校验	是	请求参数	json

请求参数

x-api-key	header	string	是	创建账号时生成的api key
x-timestamp	header	string	是	请求时间戳，与计算签名使用的时间戳保持一致
x-signature	header	string	是	根据计算签名得到的最终签名值
uid	query	string	是	第三方用户唯一标识
channel	query	string	是	渠道标识，存在则进行传递，没有传空字符串

请求示例

curl --location 'https://co.aippt.cn/api/grant/code?uid=1&channel=xxx' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-timestamp: 1696821929' \
--header 'x-signature: S52ihSWntQ317tSIR4EEfGLL9FY=' \

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	api_key	string	创建账号时生成的api key
	uid	string	第三方用户唯一标识
	code	string	初始化UI功能的时候需要传递
	time_expire	string	code有效期，24小时

响应示例

{
    "code": 0,
    "data": {
        "api_key": "645e1231d1ba5",
        "uid": "1",
        "code": "429738a59f91d6977843fd1c893bc66b",
        "time_expire": 86400
    },
    "msg": "ok"
}

【注意】身份认证

AiPPT 所有的开放 API 都需要在请求的HTTP Headers 传入x-api-key与x-token 带入您的身份 Token 信息，用于完成认证。

参数说明

x-api-key	header	string	是	创建账号时生成的api key
x-channel	header	string	是	渠道标识，适用于 B2B2C 的场景
x-token	header	string	是	通过认证接口获取到的 token

状态码

授权、鉴权相关	43100	鉴权系统错误
	43101	鉴权系统参数不合法
	43102	api_key不合法
	43103	签名不合法
API公共	40000	API请求表单校验失败
	40007	API请求参数错误
	40008	API系统错误
AI生成相关	12100	AI系统错误
	12101	AI触发违禁词验证
	12102	AI任务不存在
	12103	AI创建任务失败
	12104	AI每日创建任务额度错误
用户作品相关	10000	作品操作公共错误
	10001	作品保存失败
	10002	作品不存在
	10003	获取作品列表失败
	10004	删除作品失败
	10005	作品重命名失败

智能生成

接入前提

获取调用API所需的TOKEN请参考鉴权

创建任务

说明

接口描述	生成PPT须先调用此接口创建任务, 获取任务ID后方可进行后续生成操作
接口地址	/api/ai/chat/v2/task	请求方式	POST
权限校验	是

请求参数

type	1\|3\|4\|5\|6\|7\|8	是	1.智能生成 3.导入word 4.XMind导入 5.FreeMind导入 6.Markdown导入 7.Markdown粘贴 8.预置词
title	string	否	type=1: 用户输入标题(必填) type=7: 粘贴Markdown的标题（不传默认为: Markdown粘贴文案） type=3、4、5、6、8: 不传
content	string	否	type=1、3、4、5、6、8: 不传 type=7: 粘贴Markdown内容（必填）必传）
file	File	否	type=1、7、8: 不传 type=3: word文件（必填） type=4: XMind文件（必填） type=5: FreeMind文件（必填） type=6: Markdown文件（必填）
id	number	否	预置词id type=1、3、4、5、6、7: 不传 type=8: 预置词列表接口返回的 id字段（必填）

请求示例

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 'content=""' \
--form 'id=""' \
--form 'title="毕业季"' \
--form 'type="1"'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	id	number	任务ID，后续在AI生成的时候需要使用
	title	string	标题
	type	number	1.智能生成 3.导入word 4.XMind导入 5.FreeMind导入 6.Markdown导入 7.Markdown粘贴 8.预置词

响应示例

{
    "code": 0,
    "data": {
        "id": 1,
        "title": "毕业季",
        "type": 1,
        "api_key": "645e1231d1ba5",
        "created_at": "2023-10-26T11:05:54.079+08:00"
    },
    "msg": "success"
}

内容生成

特别注意

通过标题生成PPT的方式可选接入百度AI或默认AI百度AI的step-2采用非流式传入。
百度AI暂不支持导入文档生成PPT。

默认AI生成

步骤1.标题生成大纲

说明

接口描述	生成PPT须先调用此接口创建任务, 获取任务ID后方可进行后续生成操作
接口地址	/api/ai/chat/outline	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/outline?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

步骤2.大纲生成内容

说明

接口描述	此接口是用户通过大纲 AI生成内容，与默认AI-标题生成大纲组合使用，最终生成大纲+内容的结果，这两个步骤使用同一个任务ID。
接口地址	/api/ai/chat/content	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/content?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

百度AI生成

步骤1.标题生成大纲

说明

接口描述	此接口是通过标题生成大纲，与百度AI-大纲生成内容组合使用，最终生成大纲+内容的结果。
接口地址	/api/ai/chat/wx/outline	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/wx/outline?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"# 考研\n## "}

event:message
data:{"content":"1. 考研背景介绍\n### 1.1 考研的定义和重要性\n#### 1.1.1 考研的定义\n#### 1.1.2 考研的重要性\n### 1.2 考研的历史和发展\n#### 1.2"}

event:message
data:{"content":".1 考研的起源和发展\n#### 1.2.2 考研的现状和趋势\n## 2. 考研的准备\n### 2.1 心理准备\n#### 2.1.1 确定目标\n#### 2.1"}

......

event:message
data:{"content":"识别和评估\n#### 6.1.2 压力缓解的方法\n### 6.2 应考心态调整\n#### 6.2.1 应考心理准备\n#### 6.2.2 应考心态调整策略"}

event:close
data:api-close

步骤2.大纲生成内容

说明

接口描述	此接口是通过大纲 AI生成内容，与百度AI-标题生成大纲组合使用，最终生成大纲+内容的结果，这两个步骤使用同一个任务ID。
接口地址	/api/ai/chat/wx/content	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/wx/content?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	string	返回数据

响应示例

{
    "code": 0,
    "data": "```\n# 考研\n## 1. 考研背景介绍\n### 1.1 考研的定义和重要性\n#### 1.1.1 考研的定义\n考研是指中国全国硕士研究生统一招生考试的简称，是国家高等教育重要组成部分。考研的报名条件和要求每年都会有所变动，具体应参考当年的招生公告。\n\n#### 1.1.2 考研的重要性\n考研对于个人和社会都具有重要意义。对于个人而言，考研可以提升自身的学术水平和职业竞争力，为未来的职业发展打下坚实的基础。对于社会而言，考研能够培养更多高层次的人才，推动社会的发展和进步。\n\n### 1.2 考研的历史和发展\n#### 1.2.1 考研的起源和发展\n中国考研的历史可以追溯到1978年，当时国家恢复了研究生招生，并实行了全国统考。随着国家经济和社会的快速发展，考研的规模和影响力也不断扩大。\n\n#### 1.2.2 考研的现状和趋势\n目前，中国考研的报名人数逐年增加，竞争越来越激烈。同时，国家也在不断调整研究生招生政策和考试科目，以适应社会发展的需要。未来，随着国家经济和社会的进一步发展，考研的规模和影响力仍将继续扩大。## 2. 考研的准备\n### 2.1 心理准备\n#### 2.1.1 确定目标\n- 确定考研的目标院校和具体专业，了解目标院校的录取标准和考试要求。\n- 对自己的学术背景和学习能力进行客观评估，明确自己的优劣势，制定合理的备考计划。\n#### 2.1.2 制定计划\n- 根据目标院校的考试要求和自己的实际情况，制定详细的备考计划，包括每天的学习任务、学习时间和进度等。\n- 合理安排时间，注重劳逸结合，避免过度疲劳和压力过大。\n### 2.2 学术准备\n#### 2.2.1 专业课程的学习\n- 根据目标专业的要求，系统学习专业课程，掌握基础知识，提高学术素养。\n- 结合目标院校的教材和考试真题，进行有针对性的学习和练习。\n#### 2.2.2 考试技巧的训练\n- 熟悉考试形式和题型，掌握答题技巧和方法，提高答题速度和准确度。\n- 通过模拟考试和练习题，进行考试技巧的训练和适应，提高应对考试的能力。\n### 2.3 生活准备\n#### 2.3.1 规律的作息时间\n- 保持规律的作息时间，保证充足的睡眠和休息，避免过度疲劳和身体透支。\n- 合理安排时间，保证每天的学习时间和效率。\n#### 2.3.2 适当的体育锻炼\n- 进行适当的体育锻炼，增强身体素质和免疫力，提高学习效率和精力。\n- 选择适合自己的运动方式，如跑步、瑜伽、健身等，保持身体健康和心理平衡。## 3. 考研的考试内容\n### 3.1 公共课考试内容\n#### 3.1.1 政治理论考试\n#### 3.1.2 外语考试\n### 3.2 专业课程考试内容\n#### 3.2.1 专业基础课考试\n#### 3.2.2 专业方向课考试\n- 公共课考试内容是所有考研学生必须参加的考试，包括政治理论考试和外语考试。政治理论考试主要考察学生的政治思想和理论知识，外语考试主要考察学生的英语或其它外语水平。\n- 专业课程考试内容根据不同的专业方向有所区别，一般包括专业基础课考试和专业方向课考试。专业基础课考试主要考察学生掌握的专业基础知识，专业方向课考试主要考察学生对于特定专业方向的知识和技能掌握情况。\n- 考研的考试内容通常比较广泛，需要学生具备扎实的专业基础和广泛的知识面。同时，考研的考试难度也比较高，需要学生具备较高的学习能力和应试能力。## 4. 考研的备考策略\n### 4.1 时间管理策略\n#### 4.1.1 制定有效的学习计划\n- 根据个人实际情况，制定每日、每周、每月的学习计划，确保备考时间得到充分利用。\n- 针对不同科目，合理安排学习时间，确保各科目得到均衡发展。\n- 留出足够的时间进行复习和冲刺，确保备考效果得到巩固和提升。\n#### 4.1.2 提高学习效率\n- 制定合理的学习目标，明确每天要完成的任务，提高学习效率。\n- 保证充足的学习时间和精力，避免浪费时间或精力分散。\n- 学会自我监控和调整学习状态，及时发现并解决问题。\n### 4.2 学习技巧策略\n#### 4.2.1 阅读技巧\n- 学会快速阅读，掌握文章主旨和重要信息。\n- 善于利用关键词和重点句，加深对文章的理解。\n- 注重阅读质量而非数量，确保对文章的理解和记忆。\n#### 4.2.2 做题技巧\n- 掌握各类题型的解题方法和技巧。\n- 善于总结错题原因和解题经验。\n- 提高解题速度和准确度，注重思维能力和应试能力的提升。\n### 4.3 应试技巧策略\n#### 4.3.1 时间分配技巧\n- 根据考试时间和题型，合理分配做题时间。\n- 避免在某一道题目上花费过多时间，确保能够完成所有题目。\n- 在时间紧张的情况下，学会取舍和优化答案，保证做题效率。\n#### 4.3.2 检查试卷技巧\n- 完成所有题目后，留出一定时间进行试卷检查。\n- 检查答案是否符合要求、计算是否正确、表达是否清晰等。\n- 注意检查选择题的选项是否遗漏或重复，以及题目是否全部回答等细节问题。## 5. 考研的面试准备\n### 5.1 着装准备\n#### 5.1.1 选择合适的服装\n考研面试的服装应大方得体，符合正式的场合。考生可以选择西装套装、衬衫配西装裤等，以展现出自己的专业和严谨态度。同时，注意服装的整洁和搭配的合理性。\n#### 5.1.2 注意仪态和姿态\n在面试中，考生的仪态和姿态也是考察的一部分。考生应保持端正的坐姿，不摇晃身体，保持良好的姿态。同时，注意面部表情和眼神交流，展现出自信和热情。\n### 5.2 自我介绍准备\n#### 5.2.1 设计自我介绍内容\n自我介绍是面试中考生展示自己的一个机会。考生应该认真准备自己的自我介绍内容，包括自己的姓名、来自哪里、专业背景、实践经验等。同时，注意突出自己的特点和优势。\n#### 5.2.2 注意表达方式\n在自我介绍时，考生应保持流利的表达，注意语速和语调。同时，避免使用过多的口头禅和重复的语言。\n### 5.3 问题回答准备\n#### 5.3.1 熟悉常见面试问题\n考生应该提前熟悉一些常见的面试问题，如个人介绍、为什么选择这个专业、未来的职业规划等。对于这些问题，考生可以提前准备好答案，以便在面试中更加自信地回答。\n#### 5.3.2 学习回答问题的方法和技巧\n除了熟悉常见的问题，考生还应该学习回答问题的方法和技巧。在回答问题时，考生应该注意逻辑清晰、条理分明，同时注意表达的准确性和深度。对于一些比较困难的问题，考生可以尝试从多个角度来回答。## 6. 考研的后续工作\n### 6.1 学校选择和申请流程\n#### 6.1.1 选择适合的学校和专业\n- 根据个人兴趣和职业规划选择合适的学校和专业。\n- 考虑学校的声誉和专业的就业前景。\n- 了解学校的录取标准和专业课程设置。\n\n#### 6.1.2 熟悉申请流程和材料准备\n- 了解申请所需的材料和文件清单。\n- 熟悉申请的截止日期和申请费用的支付方式。\n- 了解如何提交申请材料和进行面试。\n\n### 6.2 其他注意事项和备忘录\n#### 6.2 熟悉入学流程和相关规定\n- 熟悉入学后的学籍管理、学费缴纳、课程安排等事项。\n- 了解学校的奖学金、助学金等相关政策。\n- 了解学校的毕业要求和学位授予条件。\n\n#### 6.2备忘录: 重要事项和注意事项\n- 保存好申请过程中的重要文件和材料。\n- 及时关注学校的通知和政策变化，确保自己符合要求。\n- 注意个人身体健康和心理健康，合理安排学习和生活。\n```",
    "msg": "success"
}

导入Word生成(默认AI)

说明

接口描述	用户上传word，前端解析 word 获取内容后请求该接口生成大纲+内容的结果
接口地址	/api/ai/chat/v2/word	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location -g --request GET 'https://co.aippt.cn/api/ai/chat/v2/word?task_id={{taskID}}' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

文件内容解析

接入前提

获取调用API所需的TOKEN请参考鉴权

说明

接口描述	此接口是将创建任务上传的 markdown、freemind、xmind 文件的内容解析为 markdown 内容。
接口地址	/api/ai/conver/file	请求方式	GET
权限校验	是	请求参数	json

请求参数

type	4\|5\|6	是	4.XMind导入 5.FreeMind导入 6.Markdown导入
task_id	number	是	任务ID

请求示例

curl --location -g --request GET 'https://co.aippt.cn/api/ai/conver/file?task_id={{taskID}}&type=4' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	string	解析后的Markdown文本

响应示例

{
    "code": 0,
    "data": "# 官网\r\n## 协议公示\r\n### \r\n### 标题\r\n#### 默认标题“天鹅到家协议公示\r\n### 公示协议tab\r\n#### 展示所有协议，数据来源单独配置数据，不读取已有的协议管理后台数据\r\n#### 元素：标题、顺序来源于配置；\r\n#### 点击互相切换协议目录，右侧子目录切换对应数据；\r\n#### 样式：默认颜色、选中颜色+小图标\r\n### 内容\r\n#### 元素：标题、跳转地址、顺序来源于配置；\r\n#### 点击跳转协议详情页：样式同PC隐私协议、只展示协议内容、不展示撤销入口、不展示公示信息等；\r\n#### 样式：默认颜色、鼠标指针浮动标红、最大折行，最多3行；\r\n#### 全部展示\r\n### 空态样式\r\n#### \r\n#### \r\n### 底部复用底部导航",
    "msg": "获取成功"
}

获取PPT数据结构

说明

接口描述	此接口是获取任务的大纲内容对应的PPT树形结构。
接口地址	/api/generate/data	请求方式	POST
权限校验	是	请求参数	json

请求参数

task_id	number	是	任务ID

请求示例

curl --location --request POST 'https://co.aippt.cn/api/generate/data' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'task_id={{taskID}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	根据Markdown文本生成的PPT树形结构

响应示例

{
    "code": 0,
    "data": {
        "children": [
            {
                "children": [
                    {
                        "children": [],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 3,
                        "parentId": 2,
                        "showTip": false,
                        "sort": 0,
                        "type": "title",
                        "value": "协议公示"
                    }
                ],
                "depth": 2,
                "direction": 1,
                "expanded": true,
                "id": 2,
                "pageIndex": 2,
                "parentId": 1,
                "showTip": false,
                "sort": 0,
                "type": "catalog",
                "value": "目录"
            },
            {
                "children": [
                    {
                        "children": [],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 5,
                        "index": 0,
                        "lastLevel": true,
                        "pageIndex": 4,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 0,
                        "type": "title",
                        "value": ""
                    },
                    {
                        "children": [
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 7,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 6,
                                "showTip": false,
                                "sort": 0,
                                "type": "title",
                                "value": "默认标题“天鹅到家协议公示"
                            }
                        ],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 6,
                        "index": 0,
                        "pageIndex": 5,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 1,
                        "type": "title",
                        "value": "标题"
                    },
                    {
                        "children": [
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 9,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 8,
                                "showTip": false,
                                "sort": 0,
                                "type": "title",
                                "value": "展示所有协议，数据来源单独配置数据，不读取已有的协议管理后台数据"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 10,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 8,
                                "showTip": false,
                                "sort": 1,
                                "type": "title",
                                "value": "元素：标题、顺序来源于配置；"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 11,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 8,
                                "showTip": false,
                                "sort": 2,
                                "type": "title",
                                "value": "点击互相切换协议目录，右侧子目录切换对应数据；"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 12,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 8,
                                "showTip": false,
                                "sort": 3,
                                "type": "title",
                                "value": "样式：默认颜色、选中颜色+小图标"
                            }
                        ],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 8,
                        "index": 0,
                        "pageIndex": 6,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 2,
                        "type": "title",
                        "value": "公示协议tab"
                    },
                    {
                        "children": [
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 14,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 13,
                                "showTip": false,
                                "sort": 0,
                                "type": "title",
                                "value": "元素：标题、跳转地址、顺序来源于配置；"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 15,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 13,
                                "showTip": false,
                                "sort": 1,
                                "type": "title",
                                "value": "点击跳转协议详情页：样式同PC隐私协议、只展示协议内容、不展示撤销入口、不展示公示信息等；"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 16,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 13,
                                "showTip": false,
                                "sort": 2,
                                "type": "title",
                                "value": "样式：默认颜色、鼠标指针浮动标红、最大折行，最多3行；"
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 17,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 13,
                                "showTip": false,
                                "sort": 3,
                                "type": "title",
                                "value": "全部展示"
                            }
                        ],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 13,
                        "index": 0,
                        "pageIndex": 7,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 3,
                        "type": "title",
                        "value": "内容"
                    },
                    {
                        "children": [
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 19,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 18,
                                "showTip": false,
                                "sort": 0,
                                "type": "title",
                                "value": ""
                            },
                            {
                                "children": [],
                                "depth": 4,
                                "direction": 1,
                                "expanded": true,
                                "id": 20,
                                "index": 0,
                                "lastLevel": true,
                                "parentId": 18,
                                "showTip": false,
                                "sort": 1,
                                "type": "title",
                                "value": ""
                            }
                        ],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 18,
                        "index": 0,
                        "pageIndex": 8,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 4,
                        "type": "title",
                        "value": "空态样式"
                    },
                    {
                        "children": [],
                        "depth": 3,
                        "direction": 1,
                        "expanded": true,
                        "id": 21,
                        "index": 0,
                        "lastLevel": true,
                        "pageIndex": 9,
                        "parentId": 4,
                        "showTip": false,
                        "sort": 5,
                        "type": "title",
                        "value": "底部复用底部导航"
                    }
                ],
                "depth": 2,
                "direction": 1,
                "expanded": true,
                "id": 4,
                "index": 0,
                "pageIndex": 3,
                "parentId": 1,
                "showTip": false,
                "sort": 1,
                "type": "title",
                "value": "协议公示"
            },
            {
                "children": [],
                "depth": 2,
                "direction": 1,
                "expanded": true,
                "id": 22,
                "pageIndex": 10,
                "parentId": 1,
                "showTip": false,
                "sort": 2,
                "type": "ending",
                "value": "结语"
            }
        ],
        "depth": 1,
        "direction": 1,
        "expanded": true,
        "id": 1,
        "index": 0,
        "pageIndex": 1,
        "parentId": 0,
        "showTip": false,
        "sort": 0,
        "type": "title",
        "value": "官网"
    },
    "msg": "获取成功"
}

导出大纲、完整内容

接入前提

获取调用API所需的TOKEN请参考鉴权

说明

接口描述	此接口用于导出大纲或完整内容。
接口地址	/api/generate/file	请求方式	POST
权限校验	是	请求参数	json

请求参数

task_id	number	是	任务ID
type	1 \| 2	是	1=导出markdown文件 2=导出思维导图图片(格式png)

请求示例

curl --location --request POST 'https://co.aippt.cn/api/generate/file' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'task_id={{taskID}}' \
--data-urlencode 'type=1'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	string	导出的文件地址(链接时效5分钟)

响应示例

{
    "code": 0,
    "data": "https://aippt-domestic.aippt.com/aippt-api-server/chat/20240129/202401292149336cde4f09a8d24821be38f2296040ad64.md?Expires=1706536473&OSSAccessKeyId=LTAI5tEC4LwH9eYcd5ANuTnS&Signature=KUunmcXyd9r%2FM8VsLNB3B1cJV6I%3D&response-content-disposition=attachment%3Bfilename%2A%3DUTF-8%27%27%25E5%25AE%2598%25E7%25BD%2591-20220221.md",
    "msg": "获取成功"
}

编辑大纲

说明

接口描述	API编辑大纲接口, 参数 content 需要根据任务类型去传对应的值: 1. 智能生成(type = 1), 需要传修改过的完整大纲数据 2. 其他类型, 需要传修改过的完整大纲+内容数据
接口地址	/api/ai/chat/v2/outline/save	请求方式	POST
权限校验	是	请求参数	json

请求参数

task_id	number	是	任务ID
content	string	是	该值为解析Markdown文本生成PPT树形结构接口返回数据data下内容的修改后的json字符串任务类型type=1: 修改过的完整大纲数据任务类型为其他: 修改过的完整大纲+内容数据

请求示例

curl --location --request POST 'https://co.aippt.cn/api/ai/chat/v2/outline/save' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'content={"children":[{"children":[],"depth":2,"direction":1,"expanded":true,"id":2,"pageIndex":2,"parentId":1,"showTip":false,"sort":0,"type":"catalog","value":"目录"},{"children":[],"depth":2,"direction":1,"expanded":true,"id":3,"pageIndex":3,"parentId":1,"showTip":false,"sort":1,"type":"ending","value":"结语"}],"depth":1,"direction":1,"expanded":true,"id":1,"index":0,"lastLevel":true,"pageIndex":1,"parentId":0,"showTip":false,"sort":0,"type":"title","value":"哈哈#嘿嘿嘿#嘻嘻嘻嘻-正文1-正文2"}' \
--data-urlencode 'task_id={{taskID}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	number	编辑大纲log id

响应示例

{
    "code": 0,
    "data": 3,
    "msg": "success"
}

模板

模板套装列表筛选项

说明

接口描述	此接口返回模板套装列表筛选项，用于模板套装列表接口的筛选项数据填充
接口地址	/api/template_component/suit/select	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求示例

curl --location --request GET 'https://co.aippt.cn/api/template_component/suit/select' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	colour.id	number	颜色ID
	colour.name	string	颜色名称
	colour.code	string	颜色值
	suit_style.id	number	风格ID
	colour.title	string	风格名称

响应示例

{
    "code": 0,
    "data": {
        "colour": [
            {
                "id": 1,
                "name": "橙色",
                "en_name": "Orange",
                "code": "#FCC462"
            },
            {
                "id": 2,
                "name": "红色",
                "en_name": "",
                "code": "#FB6E6F"
            }
        ],
        "suit_style": [
            {
                "id": 1,
                "title": "扁平简约"
            },
            {
                "id": 2,
                "title": "商务科技"
            }
        ]
    },
    "msg": "ok"
}

模板套装列表

说明

接口描述	此接口返回模板套装列表，选中后的套装用于调用 PPT生成接口。
接口地址	/api/template_component/suit/search	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求参数

style_id	number	否	风格ID
colour_id	number	否	颜色ID
page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location --request GET 'https://co.aippt.cn/api/template_component/suit/search?colour_id&page&page_size&style_id&suit_ids' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	套装ID，用于调用jsapi合成ppt接口
	list.cover_img	string	套装封面图

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 19,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 81,
                "cover_img": "//file.isheji.com/isheji-sop/0/119/styles/20221024172110271036.jpeg"
            },
            {
                "id": 80,
                "cover_img": "//file.isheji.com/isheji-sop/0/119/styles/20221024172003597548.jpeg"
            }
        ]
    },
    "msg": "ok"
}

作品

作品生成

说明

接口描述	此接口通过任务id，与用户选择或动态匹配的模版数据的模版id生成PPT画布数据并保存作品。
接口地址	/api/design/v2/save	请求方式	POST
权限校验	是	请求参数	json

请求参数

name	string	否	作品名称（不传默认: 大纲标题）
task_id	number	是	任务ID
template_id	number	是	模版套装id

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/v2/save' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'name=毕业季' \
--data-urlencode 'task_id={{taskID}}' \
--data-urlencode 'template_id={{templateID}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	id	number	主键ID，后续接口传参用到的 user_design_id
	name	string	作品名称
	cover_url	string	封面图文件地址
	size	string	画布大小

响应示例

{
    "code": 0,
    "data": {
        "id": 5634,
        "name": "毕业季",
        "cover_url": "https://aippt-domestic.aippt.com/aippt-api-server/personal/image/0/4/20231027163605yopnatz.jpeg",
        "size": "960x540"
    },
    "msg": "ok"
}

作品列表

说明

接口描述	此接口返回第三方用户作品列表
接口地址	/api/design/list	请求方式	GET
权限校验	是	请求参数	json

请求参数

order	number	是	排序 1最新创建 2最近修改
page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location 'https://co.aippt.cn/api/design/list?page=1&page_size=2&order=1' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	主键ID，后续接口传参用到的 user_design_id
	list.name	string	作品名称
	list.cover_url	string	封面图文件地址
	list.size	string	画布大小
	list.canvas_url	string	画布json地址
	list.ai_data	string	AI文案文件地址
	list.storage_time	string	保存时间
	list.created_at	string	创建时间
	list.updated_at	string	更新时间

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 4,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 16,
                "user_id": 4,
                "name": "实现财富自由的路径",
                "cover_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/image/0/4/20231027163605yopnatz.jpeg",
                "size": "960x540",
                "canvas_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/4/20231027163606rsuzjsu.json",
                "ai_data": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/4/20231027163607jqpzeag.json",
                "storage_time": "2023-10-27 16:36:08",
                "delete_time": "",
                "auto_delete_time": 0,
                "created_at": "2023-10-27 16:36:08",
                "updated_at": "2023-10-27 16:36:08"
            }
        ]
    },
    "msg": "ok"
}

作品导出

说明

接口描述	此接口会根据传入的参数生成一条导出任务并返回任务标识，需结合导出结果接口轮询返回结果。
接口地址	/api/download/export/file	请求方式	POST
权限校验	是	请求参数	json

请求参数

id	number	是	作品ID
format	png\|jpeg\|pdf\|ppt	是	导出格式
edit	string	是	导出的作品是否可编辑 true=可编辑 false=不可编辑
files_to_zip	string	是	导出的图片是否压缩为zip true=不压缩 false=压缩

请求示例

curl --location --request POST 'https://co.aippt.cn/api/download/export/file' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'edit=true' \
--data-urlencode 'files_to_zip=false' \
--data-urlencode 'format=ppt' \
--data-urlencode 'id=1'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	string	导出任务标识

响应示例

{
    "code": 0,
    "data": "cdb8146b-746b-4006-bd40-19f597e85293", // 需结合 "作品导出结果" 进行下载
    "msg": "操作成功"
}

作品导出结果

说明

接口描述	此接口需要根据作品导出接口返回的任务标识轮询查询结果。
接口地址	/api/download/export/file/result	请求方式	POST
权限校验	是	请求参数	json

请求参数

task_key	string	是	作品导出的任务标识

请求示例

curl --location --request POST 'https://co.aippt.cn/api/download/export/file/result' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'task_key={{task_key}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	Array	导出的作品链接

响应示例

{
    "code": 0,
    "data": [
        "https://aippt-domestic.aippt.com/node-server/aippt/2024-01-29/653680052115yf23h1.ppt?Expires=1706537538&OSSAccessKeyId=LTAI5tEC4LwH9eYcd5ANuTnS&Signature=u1sUfdTYQVLWWMq6bCzcP%2BE9IRo%3D&response-content-disposition=attachment%3Bfilename%2A%3DUTF-8%27%27%25E6%25AF%2595%25E4%25B8%259A%25E5%25AD%25A3.ppt"
    ],
    "msg": "导出成功"
}

作品重命名

说明

接口描述	第三方用户修改作品名称
接口地址	/api/design/save/name	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID
name	string	是	作品名称

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/save/name' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'name=作品重命名' \
--data-urlencode 'user_design_id={{designID}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	name	string	作品名称

响应示例

{
    "code": 0,
    "data": {
        "name": "重命名测试"
    },
    "msg": "ok"
}

作品删除

说明

接口描述	第三方用户删除作品
接口地址	/api/design/delete	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/delete' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'user_design_id={{designID}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

回收站

接入前提

获取调用API所需的TOKEN请参考鉴权

已删除列表

说明

接口描述	此接口返回第三方用户已删除进入回收站的作品列表
接口地址	/api/design/del/list	请求方式	GET
权限校验	是	请求参数	json

请求参数

page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location --request GET 'https://co.aippt.cn/api/design/del/list?page=1&page_size=10' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	主键ID，后续接口传参用到的 user_design_id
	list.name	string	作品名称
	list.cover_url	string	封面图文件地址
	list.size	string	画布大小
	list.canvas_url	string	画布json地址
	list.ai_data	string	AI文案文件地址
	list.storage_time	string	保存时间
	list.created_at	string	创建时间
	list.updated_at	string	更新时间

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 3,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 18,
                "user_id": 1,
                "name": "重命名测试",
                "cover_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/image/0/1/20231030192402ipkzfou.jpeg",
                "size": "960x540",
                "canvas_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/1/20231031103706nypfzgk.json",
                "ai_data": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/1/20231030192403hrjlloy.json",
                "storage_time": "2023-10-31 10:37:07",
                "delete_time": "2023-11-01 15:40:18",
                "auto_delete_time": 30,
                "created_at": "2023-10-31 10:02:01",
                "updated_at": "2023-11-01 15:40:19"
            }
        ]
    },
    "msg": "ok"
}

作品还原

说明

接口描述	第三方用户已删除作品还原
接口地址	/api/design/revert	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/revert' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'user_design_id={{designID}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

彻底删除

说明

接口描述	第三方用户已删除作品彻底删除
接口地址	/api/design/clear	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location --request POST 'https://co.aippt.cn/api/design/clear' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}' \
--data-urlencode 'user_design_id={{designID}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

预置词

预置词列表

说明

接口描述	预置词列表中的数据，可以调用预置词详情API获取可以直接生成PPT的数据
接口地址	/api/ai/chat/config/list	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求参数

page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location --request GET 'https://co.aippt.cn/api/ai/chat/config/list?page=1&page_size=10' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	number	当前页
	number	每页条数
	number	总条数
	number	预置词ID
	string	预置词标题

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 24,
            "current_page": 1,
            "page_size": 1
        },
        "list": [
            {
                "id": 1,
                "title": "数字时代的营销策划与文案创作"
            }
        ]
    },
    "msg": "ok"
}

预置词详情

说明

接口描述	用过预置词列表中的预置词ID，获取可以直接生成PPT的数据
接口地址	/api/ai/chat/config/detail	请求方式	GET
权限校验	是	请求参数	json

请求参数

id	number	是	预置词ID

请求示例

curl --location --request GET 'https://co.aippt.cn/api/ai/chat/config/detail?id=1' \
--header 'x-api-key: {{apiKey}}' \
--header 'x-channel;' \
--header 'x-token: {{token}}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	list.id	number	预置词ID
	list.title	string	预置词标题
	list.content	string	预置词大纲+内容

响应示例

{
    "code": 0,
    "data": {
        "id": 1,
        "title": "数字时代的营销策划与文案创作",
        "source": 1,
        "content": "# 数字时代的营销策划与文案创作\r\n## 1. 数字时代营销概述\r\n### 1.1 数字化转型背景\r\n#### 1.1.1 数字化趋势与影响\r\n- 介绍数字化转型对市场和消费者行为的影响，如移动互联网普及、社交媒体崛起等。\r\n- 强调数字化趋势对营销策划和文案创作带来的挑战和机遇。\r\n#### 1.1.2 传统营销与数字营销对比\r\n- 对比传统营销方式与数字营销方式的特点，如受众覆盖范围、互动性、效果监测等。\r\n- 强调数字营销的优势，促使企业意识到数字化转型的必要性。\r\n### 1.2 数字营销的重要性\r\n#### 1.2.1 扩大市场覆盖与触达目标受众\r\n- 讨论数字营销如何通过互联网和社交平台将品牌信息传播给更广泛的受众。\r\n- 强调数字化媒体对于开拓新市场和触达特定受众的重要性。\r\n#### 1.2.2 数据驱动决策的优势\r\n- 强调数字时代营销依托数据分析和用户行为洞察，帮助企业做出更明智的决策。\r\n- 讨论数据驱动营销如何提高市场反应速度和预测趋势。\r\n#### 1.2.3 个性化营销与用户体验提升\r\n- 解释个性化营销的概念，讨论如何通过个性化内容提升用户体验和增加用户粘性。\r\n- 强调数字化技术对于实现个性化营销的关键作用。\r\n#### 1.2.4 品牌互动与社交化传播\r\n- 强调数字时代品牌需要积极参与用户互动，借助社交媒体传播品牌价值和故事。\r\n- 讨论用户生成内容（UGC）对品牌影响力的重要性。\r\n\r\n## 2. 营销策略与规划\r\n### 2.1 市场调研与目标定位\r\n#### 2.1.1 目标受众画像分析\r\n- 介绍目标受众画像的重要性和构建方法，如用户调研、数据分析等。\r\n- 强调深入了解目标受众对于营销策划和文案创作的关键意义。\r\n#### 2.1.2 竞争对手分析\r\n- 解释竞争对手分析的目的和步骤，帮助企业了解市场竞争格局。\r\n- 讨论如何借鉴竞争对手经验，同时突出自身特点。\r\n#### 2.1.3 市场机会与挑战评估\r\n- 探讨市场机会和挑战对于营销策略的影响，如技术发展、消费趋势等。\r\n- 强调制定策略时需要综合考虑外部环境因素。\r\n### 2.2 品牌建设与传播策略\r\n#### 2.2.1 品牌核心理念与定位\r\n- 讨论品牌核心理念对于品牌价值传递和用户认知的重要性。\r\n- 强调品牌定位要与目标受众需求相契合。\r\n#### 2.2.2 故事讲述与情感共鸣\r\n- 强调通过故事化营销传递品牌故事，引起用户情感共鸣。\r\n- 探讨如何将故事融入文案创作，使其更加生动有趣。\r\n#### 2.2.3 跨平台传播与整合营销\r\n- 讨论在数字时代跨平台传播品牌信息的重要性，如社交媒体、网站、APP等。\r\n- 探讨整合营销策略，使不同平台的营销活动相互增强。\r\n### 2.3 内容创意与生产策略\r\n#### 2.3.1 创意策划与创作要点\r\n- 提供创意策划的方法和技巧，如头脑风暴、内容挖掘等。\r\n- 强调创意对于营销内容吸引力和独特性的重要作用。\r\n#### 2.3.2 多媒体内容开发与应用\r\n- 探讨数字时代多媒体内容的形式和应用，如视频营销、互动内容等。\r\n- 强调多媒体内容对于提升用户体验和传播效果的价值。\r\n#### 2.3.3 用户参与与UGC生成\r\n- 讨论用户参与营销的形式，如UGC内容创作、社交互动等。\r\n- 强调用户参与对于品牌认知度和口碑传播的重要影响。\r\n### 2.4 社交媒体运营策略\r\n#### 2.4.1 不同社交平台特点与选型\r\n- 介绍主流社交平台的特点和受众特征，帮助企业选择合适的社交渠道。\r\n- 强调定制化社交内容对于平台运营的重要性。\r\n#### 2.4.2 社交内容发布与管理\r\n- 提供社交媒体内容发布的最佳实践，如时间选择、互动频率等。\r\n- 探讨社交内容管理对于维护品牌形象的重要性。\r\n#### 2.4.3 社交广告与合作推广\r\n- 强调社交广告在数字营销中的地位和广泛应用。\r\n- 探讨与KOL、意见领袖的合作，增强品牌影响力。\r\n### 2.5 数据分析与效果优化\r\n#### 2.5.1 关键指标设定与数据收集\r\n- 提供数字营销中关键指标的选择和设定原则，如转化率、点击率等。\r\n- 强调数据收集对于优化策略和效果评估的重要性。\r\n#### 2.5.2 数据分析与解读\r\n- 探讨数据分析方法，帮助企业了解营销活动的效果和用户反馈。\r\n- 强调数据解读对于调整营销策略的决策支持。\r\n#### 2.5.3 优化措施与A/B测试\r\n- 提供优化营销策略的具体措施，如优化内容、调整投放时段等。\r\n- 探讨A/B测试在数字营销中的应用，帮助找出最佳方案。\r\n\r\n## 3. 文案创作与传播\r\n### 3.1 文案风格与营销目的\r\n#### 3.1.1 标语、口号与广告文案\r\n- 探讨标语、口号和广告文案的特点和创作原则。\r\n- 强调文案在传递品牌核心信息和吸引目标受众方面的重要作用。\r\n#### 3.1.2 故事化文案与情感营销\r\n- 强调通过故事化文案传递品牌故事，引起用户共鸣和情感共鸣。\r\n- 讨论情感营销在数字时代的效果和注意事项。\r\n### 3.2 内容传播与媒体选择\r\n#### 3.2.1 不同渠道的适用性与特点\r\n- 提供不同传播渠道的特点和优势，如社交媒体、搜索引擎、电子邮件等。\r\n- 强调根据目标受众和营销目的选择合适的传播渠道。\r\n#### 3.2.2 KOL与意见领袖合作\r\n- 讨论与KOL、意见领袖的合作方式和效果。\r\n- 强调借助KOL影响力提升内容传播范围和品牌认知度。\r\n### 3.3 文案在不同媒体的应用\r\n#### 3.3.1 网站与Landing Page文案\r\n- 强调网站和Landing Page文案对于引导用户行为和提高转化率的重要性。\r\n- 讨论如何优化网站文案结构和内容呈现形式。\r\n#### 3.3.2 社交媒体文案\r\n- 探讨在社交媒体平台上的文案创作特点和技巧。\r\n- 强调社交媒体文案的简洁性和吸引力。\r\n#### 3.3.3 广告文案与宣传资料\r\n- 提供广告文案和宣传资料的创作指导，如海报、宣传册等。\r\n- 强调广告文案在吸引目标受众和传递核心信息方面的重要作用。\r\n\r\n## 4. 移动营销与新技术应用\r\n### 4.1 移动端营销策略\r\n#### 4.1.1 APP营销与用户留存\r\n- 讨论在移动端推广APP的策略，如ASO、用户留存等。\r\n- 强调移动端用户体验对于APP营销的关键影响。\r\n#### 4.1.2 移动搜索与推广\r\n- 提供移动搜索引擎优化和广告推广的方法和技巧。\r\n- 强调移动搜索在数字时代的重要性。\r\n### 4.2 AR/VR与营销创意\r\n#### 4.2.1 AR/VR技术简介\r\n- 介绍AR/VR技术在数字营销中的应用潜力和优势。\r\n- 强调AR/VR技术对于提升用户体验和品牌互动的重要性。\r\n#### 4.2.2 AR/VR在营销中的应用案例\r\n- 提供AR/VR在不同行业的成功应用案例，如虚拟试衣、增强现实广告等。\r\n- 探讨AR/VR为营销带来的创新机遇。\r\n### 4.3 AI与个性化推荐\r\n#### 4.3.1 智能推荐算法原理\r\n- 解释智能推荐算法的基本原理，如协同过滤、内容推荐等。\r\n- 强调个性化推荐对于提高用户满意度和购买转化率的重要性。\r\n#### 4.3.2 个性化推荐营销实践\r\n- 探讨数字时代个性化推荐在电商和内容营销中的应用案例。\r\n- 强调AI技术对于营销策略的智能化和精准化。\r\n\r\n## 5. 法律与伦理问题\r\n### 5.1 数字营销法律法规\r\n#### 5.1.1 隐私保护与用户数据收集\r\n- 强调企业在数字营销中需要遵守隐私保护法律法规，保护用户数据安全。\r\n- 探讨用户数据收集的合规性和可行性。\r\n#### 5.1.2 广告法规与虚假宣传防范\r\n- 介绍广告法规对于虚假宣传的规定和处罚措施。\r\n- 强调数字营销中避免虚假宣传的重要性。\r\n### 5.2 伦理问题与社会责任\r\n#### 5.2.1 虚假信息与不良引导\r\n- 探讨数字营销中存在的虚假信息和不良引导问题，如网络谣言、不当营销手段等。\r\n- 强调企业应承担社会责任，避免不良营销行为。\r\n#### 5.2.2 社交媒体责任与舆论引导\r\n- 强调社交媒体平台对于内容审查和舆论引导的责任。\r\n- 讨论如何在数字营销中避免误导用户和参与不正当竞争。\r\n\r\n## 6. 未来展望与趋势预测\r\n### 6.1 数字营销趋势\r\n#### 6.1.1 新兴技术与平台发展\r\n- 探讨未来数字营销可能涌现的新兴技术和数字平台。\r\n- 强调企业需要紧跟科技发展趋势，不断创新和优化营销策略。\r\n#### 6.1.2 用户行为与消费习惯变化\r\n- 分析数字时代用户行为和消费习惯的变化趋势。\r\n- 强调数字营销需要因势利导，根据用户需求不断调整策略。\r\n### 6.2 可持续发展与社会影响\r\n#### 6.2.1 环境保护与绿色营销\r\n- 强调绿色营销在数字时代的重要性，如绿色产品推广和环保宣传。\r\n- 讨论数字营销如何促进企业可持续发展和环境保护。\r\n#### 6.2.2 社会责任与公益营销\r\n- 探讨企业在数字时代积极履行社会责任的策略，如公益合作、社会公益活动等。\r\n- 强调公益营销对于塑造正面企业形象和提升品牌声誉的意义。\r\n\r\n## 7. 成功案例分析\r\n### 7.1 行业领先者的数字营销策略\r\n- 分析行业领先企业在数字营销方面的成功策略和经验。\r\n- 强调成功案例对于其他企业借鉴和学习的重要价值。\r\n### 7.2 创意文案在营销中的应用\r\n- 探讨创意文案在数字营销中的应用效果和优势。\r\n- 强调创意在营销中的价值和创新性。\r\n### 7.3 移动营销与新技术成功案例\r\n- 分析移动营销和新技术应用在数字时代的成功案例。\r\n- 强调数字营销创新和技术应用对于企业竞争优势的重要性。\r\n\r\n## 8. 总结与实战指南\r\n### 8.1 重要观点与实践经验总结\r\n- 总结数字时代营销策划和文案创作的重要观点和核心理念。\r\n- 强调实践经验对于提高营销效果的重要性。\r\n### 8.2 制定数字营销策略的步骤与方法\r\n- 提供制定数字营销策略的具体步骤和方法，如市场调研、目标定位等。\r\n- 强调制定策略时需要综合考虑不同因素。\r\n### 8.3 营销文案创作的关键要素\r\n- 总结营销文案创作的关键要素，如定位清晰、语言简洁等。\r\n- 探讨如何根据目标受众和营销目的创作有效文案。\r\n### 8.4 营销效果监测与优化建议\r\n- 提供营销效果监测的指标和方法，以及优化建议。\r\n- 强调数据驱动优化策略的重要性，不断改进营销效果。"
    },
    "msg": "查询成功"
}

UI版本

接入SDK

引入JS

<!-- 引入js 建议您在加载js文件的时候增加一个时间戳，避免js缓存，导致最新功能无法使用 -->
<script src="https://aippt-domestic.aippt.com/static/js/aippt-iframe-sdk.js"></script>

<script>
  // 打印出信息表示成功
  console.log(AipptIframe) 
</script>

初始化SDK

// 该方法在拿到服务端返回的授权code后调用。创建一个iframe，并挂载到指定元素或body上。
// 返回值 Promise<void>
try {
  await AipptIframe.show({
  appkey: appkey,
  channel: 'xxx',
  code: code,
  editorModel: true,
  scene_auth: false
  container: undefined ,
  onMessage(eventType,data){
    console.log(eventType,data)
  }
})
} catch (e) {
  /*
    如果初始化code信息失效，请在此处捕捉错误信息
    e: {
      code: number
      data: null
      msg: string | "code已过期"
    }
  */
  
}

基础配置

appkey	授权参数	string	是	-
channel	授权参数 (没有可不传)	string	是	-
code	授权参数	string	是	-
editorModel	是否可编辑PPT模板功能	boolean	否	false
container	iframe挂载的目标DOM元素,如不传默认挂载到Body	HTMLElement	否	body
options	可选配置项	Object	否	-

options配置

fc_plate	功能板块配置(主要用于按钮的隐藏展示)	string,boolean,array	否	true
download_mode	下载场景配置	0,1,2	否	2
scene_auth	场景鉴权(针对一些关键性的步骤进行验证是否可以继续下一步)	string,boolean,array	否	false
custom_generate	自定义导入(可支持AI智能生成的标题，导入本地大纲下所有功能)	object	否	-

功能板块配置 (主要用于按钮的隐藏展示)

介绍

在创建PPT的过程中，可根据自己的业务场景需要某个功能不需要进行展示的时候，可以调用此参数进行实现。

功能提示

该参数的配置具有父子级对应关系，如果开启了生成方式(2003)，那么AI智能生成和导入本地都会进行开启。
如果只开启其中一项配置功能，例如导入word(2006)那么他将会自动向上查找导入本地大纲(2005)和生成方式(2003)，但是不会主动开启其他配置项。
具体的接收值可以为布尔值、数组、以逗号隔开的场景值字符串。
假设：
不传递的情况下，则默认全部开启。布尔值：传递true则代表全部开启，传递false则代表全部关闭。
数组： [2006,2007] 代表只开启导入word和导入xmind， [2024] 代表只开启PPT编辑器。
具体可参考下述场景值参考

场景值参考

工作台 (2001)	顶部栏(2002)
生成方式（至少选择保留一种生成方式）(2003)	AI智能生成(2004)
	导入本地大纲(2005)	导入word(2006)
		导入xmind(2007)
		导入freemind(2008)
		导入markdown(2009)
		粘贴markdown(2010)
生成大纲(2011)	大纲下载(2012)
生成大纲(2011)	思维导图编辑(2013)
合成页（至少选择保留一个按钮）(2014)	去编辑(2015)
	下载（勾选后至少保留一个二级功能）(2016)	PPT(2017)	文字可编辑(2018)
		PPT(2017)	文字不可编辑(2019)
		图片(2020)	PNG格式(2021)
		图片(2020)	JPG格式(2022)
		PDF(2023)
ppt编辑器(2024)	大纲编辑(2025)
	模板替换(2026)
	拼图(2027)
	放映(2028)
	下载（勾选后至少保留一个二级功能）(2029)	PPT(2030)	文字可编辑(2031)
		PPT(2030)	文字不可编辑(2032)
		图片(2033)	PNG格式(2034)
		图片(2033)	JPG格式(2035)
		PDF(2036)

使用方式

AipptIframe.show({
    options: { 
      // fc_plate: "2001,2002",
      // fc_plate: [2001, 2002],
      fc_plate: true // 全部开启直接传入true即可
    }, 
  })

下载配置

介绍

在创建PPT的过程中，根据自己的业务场景需要增加一些自由下载配置。

功能提示

具体的接收值只允许为number的0,1,2。
不传递的情况下，则默认是PPT内部进行下载，且发送一个下载成功之后的一个OSS链接。
该OSS链接时效为5分钟
0:只发送消息通知，但不会进行自动下载，包含可下载地址(具体可查看事件通知"PPT_DOWNLOAD" | "OUTLINE_DOWNLOAD")
1:直接进行下载，但是不会发送消息通知
2:直接进行下载，并且发送消息通知，包含可下载地址(具体可查看事件通知"PPT_DOWNLOAD" | "OUTLINE_DOWNLOAD")

使用方式

AipptIframe.show({
    options: { 
      // download_mode: 0 // 只发送消息通知，但不会进行自动下载，包含可下载地址
      // download_mode: 1 // 直接进行下载，但是不会发送消息通知
      download_mode: 2  // 直接进行下载，并且发送消息通知，包含可下载地址
    }, 
  })

场景鉴权配置

介绍

在创建PPT的过程中，根据自己的业务场景需要增加一些验证权限，可增加该配置。

功能提示

具体的接收值可以为布尔值、数组、以逗号隔开的场景值字符串。
不传递的情况下，则默认全部不需要进行鉴权
布尔值：传递true则代表全部需要进行鉴权，传递false则代表全部不需要进行鉴权。
数组： [1001,1002] 代表只开启输入生成和预置词生成需要进行验证权限。
字符串: 1001,1002 代表只开启输入生成和预置词生成需要进行验证权限。
具体可参考下述场景值参考

方法

sceneAuthContinue	是否通过当前的鉴权场景 true: 可进行到下一步 false: 不允许进行下一步具体可参考使用方式	boolean

场景值参考

生成方式	输入生成	1001	AI智能生成-输入文本后【回车】或点击【生成icon】，调起鉴权，完成后方可开始生成大纲
	预置词生成	1002	AI智能生成-点击【预置词】，调起鉴权，完成后方可开始生成大纲
	上传word	1003	上传word：点击上传或拖拽文件上传后，不启用收费接口，调起鉴权，完成后方可继续使用收费接口生成大纲
	上传xmind	1004	上传xmind：点击上传或拖拽文件上传后，不启用收费接口，调起鉴权，完成后方可继续使用收费接口生成大纲
	上传freemind	1005	上传freemind：点击上传或拖拽文件上传后，不启用收费接口，调起鉴权，完成后方可继续使用收费接口生成大纲
	上传markdown	1006	上传markdown：点击上传或拖拽文件上传后，不启用收费接口，调起鉴权，完成后方可继续使用收费接口生成大纲
	粘贴markdown	1007	粘贴markdown：粘贴内容后，点击【确认】不启用aippt收费接口，调起鉴权，完成后方可继续使用收费接口生成大纲
生成大纲	换个大纲	1021	点击【换个大纲】按钮，调起鉴权，鉴权完成后继续调起换大纲接口并返回结果
	下载大纲	1022	下载大纲：点击两处下载大纲按钮，调起鉴权，鉴权完成后开始下载大纲
	大纲导出图片	1023	大纲导出图片：点击下载为图片按钮，调起鉴权，鉴权完成后开始合成导出图片
	前往选择模板	1024	点击【下一步】按钮，调起鉴权，鉴权完成后继续流程，打开选择模板弹窗
生成PPT	生成PPT	1025	在选择模板弹窗，点击【生成PPT】按钮，调起鉴权，鉴权完成后继续流程，开始加载合成PPT
	前往编辑器	1026	点击【去编辑】按钮，调起鉴权，鉴权完成后继续流程，进入编辑器
	下载	1027	点击【下载】按钮，无论下载什么格式，点击弹窗内的【下载】按钮后，调起鉴权，鉴权完成后继续流程，开始合成下载，弹出下载loading弹窗
编辑器	PPT下载	1028
编辑器	导出拼图	1029	拼图后点击【导出】按钮，调起鉴权，鉴权完成后继续流程，开始导出图片

使用方式

AipptIframe.show({
    options: { 
      // scene_auth: "1001,1002",
      // scene_auth: [1001, 1002],
      scene_auth: false, // 默认值
    }, 
    onMessage(type,data){  
      if (type === 'SCENE_AUTH') { // 鉴权功能验证
        if (data.scene === 1021) { // 点击换个大纲 不允许进行下一步
           AipptIframe.sceneAuthContinue(false); 
        } else {
          AipptIframe.sceneAuthContinue(true); // 可继续执行下一步
        } 
      } 
    }
  })

自定义导入功能

在创建PPT的过程中，根据自己的业务场景可增加自由传递关键词或者文件跳转至自动生成大纲页面。

参数

custom_generate	type	1 \| 3 \| 4 \| 5 \| 6 \| 7 \| 11	1: AI标题输入 (最大100字符) 3: Word导入 4: Xmind导入 5: Freemind导入 6: markdown导入 7: markdown文本输入 11: 文本输入 (收费规则: Word导入付费)
custom_generate	content	string / File	如果同级参数type是1 \| 7 \| 11，则类型为string。如果同级参数type是3、4、5、6则类型为File。

异常处理

在初始化自定义导入的情况下会存在异常处理，用户可根据下列的错误进行排查。

type参数不匹配	{type: 'custom_generate', code: -1, message: '自定义生成数据类型错误' }
type类型为1且content为空或content大于100字符	{ type: 'custom_generate', code: -1, message: 'AI标题不符合要求' }
type类型为7且content为空或者content不符合解析的markdown要求	{ type: 'custom_generate',code: -1, message: 'markdown文本内容不符合要求'}
type类型为11且content为空	{ type: 'custom_generate', code: -1, message: '文本内容不允许为空' }
type类型为3、4、5、6且content文件大小大于5M	{ type: 'custom_generate', code: -1, message: '文件大小不能超过5M' }
type类型为3、4、5、6且content不是对应的导入文件类型	{ type: 'custom_generate', code: -1, message: '上传文件不符合要求' }

使用方法

try {
     await AipptIframe.show({
        appkey: appkey,
        channel: channel,
        code: code,
        editorModel: editorModel,
        container: container,
        container: 'body',
        options: {
          custom_generate: {
            content: "标题",
            type: 1
          }
        }
      })
  } catch (e) {  // 进行异常描述的信息捕获
    console.log(e, 'catch exception')
  }

事件通知介绍

我们的服务通过iframe页面向您的应用程序发送消息通知，以便实时通信和数据更新。您需要在您的应用程序中进行一些设置，以确保能够正确地接收这些通知。

说明

JS版本

引入JS

<!-- 引入js 建议您在加载js文件的时候增加一个时间戳，避免js缓存，导致最新功能无法使用 -->
<script src="https://aippt-domestic.aippt.com/static/js/aippt-jssdk.js"></script>

<script>
  // 打印出信息表示成功
  console.log(AipptJsapiSDK) 
</script>

初始化SDK

// 该方法在拿到服务端返回的授权code后调用。创建一个iframe，并挂载到指定元素或body上。
// 返回值 Promise<void>
const aipptJsapi = await AipptJsapiSDK.init({
	appkey: 'Your Appkey',
	channel: 'Your Channel',
	code: 'Your Code',
});

JsApi.convertWordBlob

说明

解析Word文件生成文本

参数

file	string	是	word文件，后缀为 .docx	-
taskId	string	是	任务ID	-

响应内容

content	string	普通文本, 非 markdown 文本, 需要调用‘serviceAPI的导入文档生成’的 API

示例

const { content } = await JsApi.convertWordBlob({
  file,
  taskId:659
})

JsApi.convertFileBlob

说明

解析 xmind、markdown、freemind 文件生成 markdown 文本

参数

file	string	是	解析文件，后缀为xmind,md,mm	-
taskId	string	是	任务ID	-

响应内容

content	string	markdown 文本
data	object	根据 markdown 文本生成的 PPT 树形结构

示例

const { content } = await JsApi.convertFileBlob({
  file,
  taskId:659
})

JsApi.generateData

说明

解析Markdown文本生成PPT树形结构

参数

content	string	是	Markdown文本	-

响应内容

content	string	markdown 文本
data	object	根据 markdown 文本生成的 PPT 树形结构

示例

const { content, data } = await JsApi.generateData({
   content:'# 标题\n## 章节一\n### 章节一第1页\n- 这是内容\n- 这是内容\n### 章节一第2页\n- 这是内容\n- 这是内容'
})

JsApi.exportData

说明

导出大纲、完整内容

参数

content	string	是	Markdown文本	-
fileName	string	是	导出的文件名	-
ext	md \| json	否	导出的文件类型	md
autoDownload	boolean	否	是否自动下载	false

响应内容

返回blob对象

示例

const blob = JsApi.exportData({
  content:"# 标题\n## 章节一\n### 章节一第1页\n- 这是内容\n- 这是内容\n### 章节一第2页\n- 这是内容\n- 这是内容",
  fileName:"大纲",
  ext:"md"
})

JsApi.generatePPT

说明

传入通过API接口生成的大纲数据，与用户选择或动态匹配的模版数据生成PPT画布数据。

参数

content	string	是	完整内容的markdown文本	-
templateId	number	是	模板id	-
name	string	否	作品名称	大纲标题
taskId	number	是	任务ID	-

响应内容

coverImage	string	封面截图
id	number	作品ID
name	string	作品名称
size	string	作品分辨率

JsApi.previewPPT

说明

传入PPT生成时返回的canvasData, 自定义预览展示。

参数

id	number	是	作品id	-

响应内容

size	string	作品分辨率, {width: number, height: number}
render	function	渲染函数, async (dom: Vue3子组件, width?: number, height?:number) => void
exportImage	function	作品分辨率, async (imageType: "png" \| "jpeg", qulity=0.8) => blob

示例

const pages = JsApi.previewPPT({ id: 111 })

JsApi.exportPPT

说明

传入PPT生成时返回的canvasData与想要类型,生成对应文件的Blob对象。

参数

id	number	是	作品id	-

响应内容

成功	url	string	可下载链接
失败	code	number	错误状态码
	data	string	无数据
	msg	string	错误信息描述

服务端版API

创建任务

说明

生成PPT须先调用此接口创建任务, 获取任务ID后方可进行后续生成操作。

请求参数

type	1\|3\|4\|5\|6\|7\|8	是	1.智能生成 3.导入word 4.XMind导入 5.FreeMind导入 6.Markdown导入 7.Markdown粘贴 8.预置词
title	string	是	type=1: 用户输入标题 type=8: 预置词 type=3,4,5,6,7: 导入文档文件名
content	string	是	type=1: 不传 type=3,4,5,6,7,8: 前端解析后的文档内容（必传）

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/task'
--header 'x-api-key: 645e1231d1ba5'
--header 'x-channel: F'
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'
--header 'Content-Type: application/json'
--data '{
    "type":1,
    "title":"毕业季"
}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	id	number	任务ID，后续在AI生成的时候需要使用
	title	string	标题
	status	number	1: 生成中；2: 生成完成
	import_url	string	type=3、4、5、6、7、8: 导入文档内容转储地址
	type	number	1.智能生成 3.导入word 4.XMind导入 5.FreeMind导入 6.Markdown导入 7.Markdown粘贴 8.预置词

响应示例

{
    "code": 0,
    "data": {
        "id": 44,
        "title": "毕业季",
        "status": 1,
        "import_url": "",
        "type": 1,
        "api_key": "645e1231d1ba5",
        "created_at": "2023-10-26T11:05:54.079+08:00"
    },
    "msg": "success"
}

内容生成

特别注意

通过标题生成PPT的方式可选接入百度AI或默认AI百度AI的step-2采用非流式传入。
百度AI暂不支持导入文档生成PPT。

默认AI生成

步骤1.标题生成大纲

说明

接口描述	此接口是通过标题生成大纲，与默认AI-大纲生成内容组合使用，最终生成大纲 + 内容的结果。
接口地址	/api/ai/chat/outline	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/outline?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

步骤2.大纲生成内容

说明

接口描述	此接口是用户通过大纲 AI生成内容，与默认AI-标题生成大纲组合使用，最终生成大纲+内容的结果，这两个步骤使用同一个任务ID。
接口地址	/api/ai/chat/content	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/content?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

百度AI生成

步骤1.标题生成大纲

说明

接口描述	此接口是通过标题生成大纲，与百度AI-大纲生成内容组合使用，最终生成大纲+内容的结果。
接口地址	/api/ai/chat/wx/outline	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/wx/outline?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"# 考研\n## "}

event:message
data:{"content":"1. 考研背景介绍\n### 1.1 考研的定义和重要性\n#### 1.1.1 考研的定义\n#### 1.1.2 考研的重要性\n### 1.2 考研的历史和发展\n#### 1.2"}

event:message
data:{"content":".1 考研的起源和发展\n#### 1.2.2 考研的现状和趋势\n## 2. 考研的准备\n### 2.1 心理准备\n#### 2.1.1 确定目标\n#### 2.1"}

......

event:message
data:{"content":"识别和评估\n#### 6.1.2 压力缓解的方法\n### 6.2 应考心态调整\n#### 6.2.1 应考心理准备\n#### 6.2.2 应考心态调整策略"}

event:close
data:api-close

步骤2.大纲生成内容

说明

接口描述	此接口是通过大纲 AI生成内容，与百度AI-标题生成大纲组合使用，最终生成大纲+内容的结果，这两个步骤使用同一个任务ID。
接口地址	/api/ai/chat/wx/content	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/wx/content?task_id=44' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	string	返回数据

响应示例

{
    "code": 0,
    "data": "```\n# 考研\n## 1. 考研背景介绍\n### 1.1 考研的定义和重要性\n#### 1.1.1 考研的定义\n考研是指中国全国硕士研究生统一招生考试的简称，是国家高等教育重要组成部分。考研的报名条件和要求每年都会有所变动，具体应参考当年的招生公告。\n\n#### 1.1.2 考研的重要性\n考研对于个人和社会都具有重要意义。对于个人而言，考研可以提升自身的学术水平和职业竞争力，为未来的职业发展打下坚实的基础。对于社会而言，考研能够培养更多高层次的人才，推动社会的发展和进步。\n\n### 1.2 考研的历史和发展\n#### 1.2.1 考研的起源和发展\n中国考研的历史可以追溯到1978年，当时国家恢复了研究生招生，并实行了全国统考。随着国家经济和社会的快速发展，考研的规模和影响力也不断扩大。\n\n#### 1.2.2 考研的现状和趋势\n目前，中国考研的报名人数逐年增加，竞争越来越激烈。同时，国家也在不断调整研究生招生政策和考试科目，以适应社会发展的需要。未来，随着国家经济和社会的进一步发展，考研的规模和影响力仍将继续扩大。## 2. 考研的准备\n### 2.1 心理准备\n#### 2.1.1 确定目标\n- 确定考研的目标院校和具体专业，了解目标院校的录取标准和考试要求。\n- 对自己的学术背景和学习能力进行客观评估，明确自己的优劣势，制定合理的备考计划。\n#### 2.1.2 制定计划\n- 根据目标院校的考试要求和自己的实际情况，制定详细的备考计划，包括每天的学习任务、学习时间和进度等。\n- 合理安排时间，注重劳逸结合，避免过度疲劳和压力过大。\n### 2.2 学术准备\n#### 2.2.1 专业课程的学习\n- 根据目标专业的要求，系统学习专业课程，掌握基础知识，提高学术素养。\n- 结合目标院校的教材和考试真题，进行有针对性的学习和练习。\n#### 2.2.2 考试技巧的训练\n- 熟悉考试形式和题型，掌握答题技巧和方法，提高答题速度和准确度。\n- 通过模拟考试和练习题，进行考试技巧的训练和适应，提高应对考试的能力。\n### 2.3 生活准备\n#### 2.3.1 规律的作息时间\n- 保持规律的作息时间，保证充足的睡眠和休息，避免过度疲劳和身体透支。\n- 合理安排时间，保证每天的学习时间和效率。\n#### 2.3.2 适当的体育锻炼\n- 进行适当的体育锻炼，增强身体素质和免疫力，提高学习效率和精力。\n- 选择适合自己的运动方式，如跑步、瑜伽、健身等，保持身体健康和心理平衡。## 3. 考研的考试内容\n### 3.1 公共课考试内容\n#### 3.1.1 政治理论考试\n#### 3.1.2 外语考试\n### 3.2 专业课程考试内容\n#### 3.2.1 专业基础课考试\n#### 3.2.2 专业方向课考试\n- 公共课考试内容是所有考研学生必须参加的考试，包括政治理论考试和外语考试。政治理论考试主要考察学生的政治思想和理论知识，外语考试主要考察学生的英语或其它外语水平。\n- 专业课程考试内容根据不同的专业方向有所区别，一般包括专业基础课考试和专业方向课考试。专业基础课考试主要考察学生掌握的专业基础知识，专业方向课考试主要考察学生对于特定专业方向的知识和技能掌握情况。\n- 考研的考试内容通常比较广泛，需要学生具备扎实的专业基础和广泛的知识面。同时，考研的考试难度也比较高，需要学生具备较高的学习能力和应试能力。## 4. 考研的备考策略\n### 4.1 时间管理策略\n#### 4.1.1 制定有效的学习计划\n- 根据个人实际情况，制定每日、每周、每月的学习计划，确保备考时间得到充分利用。\n- 针对不同科目，合理安排学习时间，确保各科目得到均衡发展。\n- 留出足够的时间进行复习和冲刺，确保备考效果得到巩固和提升。\n#### 4.1.2 提高学习效率\n- 制定合理的学习目标，明确每天要完成的任务，提高学习效率。\n- 保证充足的学习时间和精力，避免浪费时间或精力分散。\n- 学会自我监控和调整学习状态，及时发现并解决问题。\n### 4.2 学习技巧策略\n#### 4.2.1 阅读技巧\n- 学会快速阅读，掌握文章主旨和重要信息。\n- 善于利用关键词和重点句，加深对文章的理解。\n- 注重阅读质量而非数量，确保对文章的理解和记忆。\n#### 4.2.2 做题技巧\n- 掌握各类题型的解题方法和技巧。\n- 善于总结错题原因和解题经验。\n- 提高解题速度和准确度，注重思维能力和应试能力的提升。\n### 4.3 应试技巧策略\n#### 4.3.1 时间分配技巧\n- 根据考试时间和题型，合理分配做题时间。\n- 避免在某一道题目上花费过多时间，确保能够完成所有题目。\n- 在时间紧张的情况下，学会取舍和优化答案，保证做题效率。\n#### 4.3.2 检查试卷技巧\n- 完成所有题目后，留出一定时间进行试卷检查。\n- 检查答案是否符合要求、计算是否正确、表达是否清晰等。\n- 注意检查选择题的选项是否遗漏或重复，以及题目是否全部回答等细节问题。## 5. 考研的面试准备\n### 5.1 着装准备\n#### 5.1.1 选择合适的服装\n考研面试的服装应大方得体，符合正式的场合。考生可以选择西装套装、衬衫配西装裤等，以展现出自己的专业和严谨态度。同时，注意服装的整洁和搭配的合理性。\n#### 5.1.2 注意仪态和姿态\n在面试中，考生的仪态和姿态也是考察的一部分。考生应保持端正的坐姿，不摇晃身体，保持良好的姿态。同时，注意面部表情和眼神交流，展现出自信和热情。\n### 5.2 自我介绍准备\n#### 5.2.1 设计自我介绍内容\n自我介绍是面试中考生展示自己的一个机会。考生应该认真准备自己的自我介绍内容，包括自己的姓名、来自哪里、专业背景、实践经验等。同时，注意突出自己的特点和优势。\n#### 5.2.2 注意表达方式\n在自我介绍时，考生应保持流利的表达，注意语速和语调。同时，避免使用过多的口头禅和重复的语言。\n### 5.3 问题回答准备\n#### 5.3.1 熟悉常见面试问题\n考生应该提前熟悉一些常见的面试问题，如个人介绍、为什么选择这个专业、未来的职业规划等。对于这些问题，考生可以提前准备好答案，以便在面试中更加自信地回答。\n#### 5.3.2 学习回答问题的方法和技巧\n除了熟悉常见的问题，考生还应该学习回答问题的方法和技巧。在回答问题时，考生应该注意逻辑清晰、条理分明，同时注意表达的准确性和深度。对于一些比较困难的问题，考生可以尝试从多个角度来回答。## 6. 考研的后续工作\n### 6.1 学校选择和申请流程\n#### 6.1.1 选择适合的学校和专业\n- 根据个人兴趣和职业规划选择合适的学校和专业。\n- 考虑学校的声誉和专业的就业前景。\n- 了解学校的录取标准和专业课程设置。\n\n#### 6.1.2 熟悉申请流程和材料准备\n- 了解申请所需的材料和文件清单。\n- 熟悉申请的截止日期和申请费用的支付方式。\n- 了解如何提交申请材料和进行面试。\n\n### 6.2 其他注意事项和备忘录\n#### 6.2 熟悉入学流程和相关规定\n- 熟悉入学后的学籍管理、学费缴纳、课程安排等事项。\n- 了解学校的奖学金、助学金等相关政策。\n- 了解学校的毕业要求和学位授予条件。\n\n#### 6.2备忘录: 重要事项和注意事项\n- 保存好申请过程中的重要文件和材料。\n- 及时关注学校的通知和政策变化，确保自己符合要求。\n- 注意个人身体健康和心理健康，合理安排学习和生活。\n```",
    "msg": "success"
}

导入文档生成(默认AI)

说明

接口描述	用户上传word，前端解析 word 获取内容后请求该接口生成大纲+内容的结果
接口地址	/api/ai/chat/word	请求方式	GET
权限校验	是	请求参数	json
响应类型	text/event-stream

请求参数

task_id	number	是	任务ID

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/word?task_id=50' \
--header 'x-api-key: 645e1231d1ba222' \
--header 'x-channel: ' \
--header 'x-token: Y2QYY2UYNWYTZWU0ZC0ZODIYLTG4YTKTNZE3NDM5YWM1YZG3'

响应内容

event		string	消息类型 1.message正常数据流 2.close结束 3.error错误 4.filter触发过滤，也算生成失败
data	content	string	返回内容

响应示例

event:message
data:{"content":"``"}

event:message
data:{"content":"`\n"}

event:message
data:{"content":"#"}

event:message
data:{"content":" 业"}

......

event:message
data:{"content":"```"}

event:close
data:api-close

编辑大纲

说明

接口描述	API编辑大纲接口, 需要根据task任务类型去传对应的参数: 1. 智能生成(task type = 1), 需要传参outline(修改过的完整大纲数据) 2. 导入文档生成(task type = 3、4、5、6、7、8), 需要传参content(修改过的完整大纲+内容数据)
接口地址	/api/ai/chat/outline/save	请求方式	POST
权限校验	是	请求参数	json

请求参数

task_id	number	是	任务ID
outline	string	否	任务类型是: 智能生成（task type = 1），此字段必传。修改过的完整大纲数据
content	string	否	任务类型是: 导入文档生成（task type = 3、4、5、6、7、8），此字段必传。修改过的完整大纲+内容数据

请求示例

curl --location 'http://127.0.0.1:9001/api/ai/chat/outline/save' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-token: MDC1MZCZMJKTNTDIYS0ZNJLLLTKWMJMTODE3M2M2YJQYNTE0' \
--header 'Content-Type: application/json' \
--data '{    
    "task_id":1,
    "outline":"```# 保温找平凝胶产品介绍## 1. 保温找平凝胶的概述### 1.1 保温找平凝胶的定义#### 1.1.1 保温找平凝胶的成分#### 1.1.2 保温找平凝胶的特点### 1.2 保温找平凝胶的应用领域#### 1.2.1 建筑行业#### 1.2.2 工业领域#### 1.2.3 农业领域#### 1.2.4 其他领域## 2. 保温找平凝胶的产品分类### 2.1 根据成分分类#### 2.1.1 有机保温找平凝胶#### 2.1.2 无机保温找平凝胶### 2.2 根据用途分类#### 2.2.1 建筑保温找平凝胶#### 2.2.2 工业保温找平凝胶#### 2.2.3 农业保温找平凝胶## 3. 保温找平凝胶的使用方法### 3.1 准备工作#### 3.1.1 基层处理#### 3.1.2 材料准备#### 3.1.3 工具准备### 3.2 操作步骤#### 3.2.1 调制凝胶#### 3.2.2 找平处理#### 3.2.3 保温处理#### 3.2.4 表面处理## 4. 保温找平凝胶的优缺点### 4.1 优点#### 4.1.1 保温性能好#### 4.1.2 施工方便快捷#### 4.1.3 使用寿命长#### 4.1.4 环保安全### 4.2 缺点#### 4.2.1 价格相对较高#### 4.2.2 有些凝胶对基层要求较高#### 4.2.3 部分凝胶的施工要求较高## 5. 保温找平凝胶的市场前景### 5.1 国内市场现状#### 5.1.1 市场规模#### 5.1.2 市场竞争格局#### 5.1.3 市场发展趋势### 5.2 国际市场现状#### 5.2.1 市场规模#### 5.2.2 市场竞争格局#### 5.2.3 市场发展趋势### 5.3 市场前景分析#### 5.3.1 国内市场前景#### 5.3.2 国际市场前景#### 5.3.3 行业发展趋势分析3```"
}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
code	number	编辑大纲log id

响应示例

{
    "code": 0,
    "data": 3,
    "msg": "success"
}

模板

模板套装列表筛选项

说明

接口描述	此接口返回模板套装列表筛选项，用于模板套装列表接口的筛选项数据填充
接口地址	/api/template_component/suit/select	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求示例

curl --location 'https://co.aippt.cn/api/template_component/suit/select' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: D' \
--header 'x-token: MWZIOWE3ZTGTOTMZZS0ZNDC5LTHMNTUTMTHIMDZHYJLIMJGW'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	colour.id	number	颜色ID
	colour.name	string	颜色名称
	colour.code	string	颜色值
	suit_style.id	number	风格ID
	colour.title	string	风格名称

响应示例

{
    "code": 0,
    "data": {
        "colour": [
            {
                "id": 1,
                "name": "橙色",
                "en_name": "Orange",
                "code": "#FCC462"
            },
            {
                "id": 2,
                "name": "红色",
                "en_name": "",
                "code": "#FB6E6F"
            }
        ],
        "suit_style": [
            {
                "id": 1,
                "title": "扁平简约"
            },
            {
                "id": 2,
                "title": "商务科技"
            }
        ]
    },
    "msg": "ok"
}

模板套装列表

说明

接口描述	此接口返回模板套装列表，选中后的套装用于调用 PPT生成接口。
接口地址	/api/template_component/suit/search	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求参数

style_id	number	否	风格ID
colour_id	number	否	颜色ID
page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location 'https://co.aippt.cn/api/template_component/suit/search' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: D' \
--header 'x-token: MWZIOWE3ZTGTOTMZZS0ZNDC5LTHMNTUTMTHIMDZHYJLIMJGW'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	套装ID，用于调用jsapi合成ppt接口
	list.cover_img	string	套装封面图

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 19,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 81,
                "cover_img": "//file.isheji.com/isheji-sop/0/119/styles/20221024172110271036.jpeg"
            },
            {
                "id": 80,
                "cover_img": "//file.isheji.com/isheji-sop/0/119/styles/20221024172003597548.jpeg"
            }
        ]
    },
    "msg": "ok"
}

作品

作品列表

说明

接口描述	此接口返回第三方用户作品列表
接口地址	/api/design/list	请求方式	GET
权限校验	是	请求参数	json

请求参数

order	number	是	排序 1最新创建 2最近修改
page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location 'https://co.aippt.cn/api/design/list?page=1&page_size=2&order=1' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	主键ID，后续接口传参用到的 user_design_id
	list.name	string	作品名称
	list.cover_url	string	封面图文件地址
	list.size	string	画布大小
	list.canvas_url	string	画布json地址
	list.ai_data	string	AI文案文件地址
	list.storage_time	string	保存时间
	list.created_at	string	创建时间
	list.updated_at	string	更新时间

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 4,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 16,
                "user_id": 4,
                "name": "实现财富自由的路径",
                "cover_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/image/0/4/20231027163605yopnatz.jpeg",
                "size": "960x540",
                "canvas_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/4/20231027163606rsuzjsu.json",
                "ai_data": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/4/20231027163607jqpzeag.json",
                "storage_time": "2023-10-27 16:36:08",
                "delete_time": "",
                "auto_delete_time": 0,
                "created_at": "2023-10-27 16:36:08",
                "updated_at": "2023-10-27 16:36:08"
            }
        ]
    },
    "msg": "ok"
}

作品重命名

说明

接口描述	第三方用户修改作品名称
接口地址	/api/design/save/name	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID
name	string	是	作品名称

请求示例

curl --location 'https://co.aippt.cn/api/design/save/name' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY' \
--header 'Content-Type: application/json' \
--data '{
    "user_design_id":18,
    "name":"重命名测试"
}'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	name	string	作品名称

响应示例

{
    "code": 0,
    "data": {
        "name": "重命名测试"
    },
    "msg": "ok"
}

作品删除

说明

接口描述	第三方用户删除作品
接口地址	/api/design/delete	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location 'https://co.aippt.cn/api/design/delete' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY' \
--header 'Content-Type: application/json' \
--data '{
    "user_design_id":18
}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

回收站

已删除列表

说明

接口描述	此接口返回第三方用户已删除进入回收站的作品列表
接口地址	/api/design/del/list	请求方式	POST
权限校验	是	请求参数	json

请求参数

page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location 'https://co.aippt.cn/api/design/del/list?page=1&page_size=2' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: ' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	pagination.current_page	number	当前页
	pagination.page_size	number	每页条数
	pagination.total	number	总条数
	list.id	number	主键ID，后续接口传参用到的 user_design_id
	list.name	string	作品名称
	list.cover_url	string	封面图文件地址
	list.size	string	画布大小
	list.canvas_url	string	画布json地址
	list.ai_data	string	AI文案文件地址
	list.storage_time	string	保存时间
	list.created_at	string	创建时间
	list.updated_at	string	更新时间

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 3,
            "current_page": 1,
            "page_size": 2
        },
        "list": [
            {
                "id": 18,
                "user_id": 1,
                "name": "重命名测试",
                "cover_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/image/0/1/20231030192402ipkzfou.jpeg",
                "size": "960x540",
                "canvas_url": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/1/20231031103706nypfzgk.json",
                "ai_data": "https://aippt-domestic-test.aippt.com/aippt-api-server/personal/other/0/1/20231030192403hrjlloy.json",
                "storage_time": "2023-10-31 10:37:07",
                "delete_time": "2023-11-01 15:40:18",
                "auto_delete_time": 30,
                "created_at": "2023-10-31 10:02:01",
                "updated_at": "2023-11-01 15:40:19"
            }
        ]
    },
    "msg": "ok"
}

作品还原

说明

接口描述	第三方用户已删除作品还原
接口地址	/api/design/revert	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location 'https://co.aippt.cn/api/design/revert' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: ' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY' \
--header 'Content-Type: application/json' \
--data '{
    "user_design_id":18
}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

彻底删除

说明

接口描述	第三方用户已删除作品彻底删除
接口地址	/api/design/clear	请求方式	POST
权限校验	是	请求参数	json

请求参数

user_design_id	number	是	作品ID

请求示例

curl --location 'https://co.aippt.cn/api/design/clear' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY' \
--header 'Content-Type: application/json' \
--data '{
    "user_design_id":18
}'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	object	返回数据

响应示例

{
    "code": 0,
    "data": [],
    "msg": "ok"
}

预置词

预置词列表

说明

接口描述	预置词列表中的数据，可以调用预置词详情API获取可以直接生成PPT的数据
接口地址	/api/ai/chat/config/list	请求方式	GET
权限校验	是	请求参数	json
图片示例

请求参数

page	number	否	页码默认1
page_size	number	否	每页展示数量默认20

请求示例

curl --location 'https://co.aippt.cn/api/ai/chat/config/list?page=1&page_size=1' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY'

响应内容

code	number	返回码，0表示成功，非0表示异常
msg	string	返回提示信息
data	number	当前页
	number	每页条数
	number	总条数
	number	预置词ID
	string	预置词标题

响应示例

{
    "code": 0,
    "data": {
        "pagination": {
            "total": 24,
            "current_page": 1,
            "page_size": 1
        },
        "list": [
            {
                "id": 1,
                "title": "数字时代的营销策划与文案创作"
            }
        ]
    },
    "msg": "ok"
}

预置词详情

说明

接口描述	用过预置词列表中的预置词ID，获取可以直接生成PPT的数据
接口地址	/api/ai/chat/config/detail	请求方式	GET
权限校验	是	请求参数	json

请求参数

id	number	是	预置词ID

请求示例

curl --location 'https://aippt-api-server-test.wxbjq.top/api/ai/chat/config/detail?id=1' \
--header 'x-api-key: 645e1231d1ba5' \
--header 'x-channel: xxx' \
--header 'x-token: M2E1ZJUYMDETYTDIYS0ZNDA3LWE1NTATNDA5NZVHZGMXMDYY'

响应内容

code		number	返回码，0表示成功，非0表示异常
msg		string	返回提示信息
data	list.id	number	预置词ID
	list.title	string	预置词标题
	list.content	string	预置词大纲+内容

响应示例

{
    "code": 0,
    "data": {
        "id": 1,
        "title": "数字时代的营销策划与文案创作",
        "source": 1,
        "content": "# 数字时代的营销策划与文案创作\r\n## 1. 数字时代营销概述\r\n### 1.1 数字化转型背景\r\n#### 1.1.1 数字化趋势与影响\r\n- 介绍数字化转型对市场和消费者行为的影响，如移动互联网普及、社交媒体崛起等。\r\n- 强调数字化趋势对营销策划和文案创作带来的挑战和机遇。\r\n#### 1.1.2 传统营销与数字营销对比\r\n- 对比传统营销方式与数字营销方式的特点，如受众覆盖范围、互动性、效果监测等。\r\n- 强调数字营销的优势，促使企业意识到数字化转型的必要性。\r\n### 1.2 数字营销的重要性\r\n#### 1.2.1 扩大市场覆盖与触达目标受众\r\n- 讨论数字营销如何通过互联网和社交平台将品牌信息传播给更广泛的受众。\r\n- 强调数字化媒体对于开拓新市场和触达特定受众的重要性。\r\n#### 1.2.2 数据驱动决策的优势\r\n- 强调数字时代营销依托数据分析和用户行为洞察，帮助企业做出更明智的决策。\r\n- 讨论数据驱动营销如何提高市场反应速度和预测趋势。\r\n#### 1.2.3 个性化营销与用户体验提升\r\n- 解释个性化营销的概念，讨论如何通过个性化内容提升用户体验和增加用户粘性。\r\n- 强调数字化技术对于实现个性化营销的关键作用。\r\n#### 1.2.4 品牌互动与社交化传播\r\n- 强调数字时代品牌需要积极参与用户互动，借助社交媒体传播品牌价值和故事。\r\n- 讨论用户生成内容（UGC）对品牌影响力的重要性。\r\n\r\n## 2. 营销策略与规划\r\n### 2.1 市场调研与目标定位\r\n#### 2.1.1 目标受众画像分析\r\n- 介绍目标受众画像的重要性和构建方法，如用户调研、数据分析等。\r\n- 强调深入了解目标受众对于营销策划和文案创作的关键意义。\r\n#### 2.1.2 竞争对手分析\r\n- 解释竞争对手分析的目的和步骤，帮助企业了解市场竞争格局。\r\n- 讨论如何借鉴竞争对手经验，同时突出自身特点。\r\n#### 2.1.3 市场机会与挑战评估\r\n- 探讨市场机会和挑战对于营销策略的影响，如技术发展、消费趋势等。\r\n- 强调制定策略时需要综合考虑外部环境因素。\r\n### 2.2 品牌建设与传播策略\r\n#### 2.2.1 品牌核心理念与定位\r\n- 讨论品牌核心理念对于品牌价值传递和用户认知的重要性。\r\n- 强调品牌定位要与目标受众需求相契合。\r\n#### 2.2.2 故事讲述与情感共鸣\r\n- 强调通过故事化营销传递品牌故事，引起用户情感共鸣。\r\n- 探讨如何将故事融入文案创作，使其更加生动有趣。\r\n#### 2.2.3 跨平台传播与整合营销\r\n- 讨论在数字时代跨平台传播品牌信息的重要性，如社交媒体、网站、APP等。\r\n- 探讨整合营销策略，使不同平台的营销活动相互增强。\r\n### 2.3 内容创意与生产策略\r\n#### 2.3.1 创意策划与创作要点\r\n- 提供创意策划的方法和技巧，如头脑风暴、内容挖掘等。\r\n- 强调创意对于营销内容吸引力和独特性的重要作用。\r\n#### 2.3.2 多媒体内容开发与应用\r\n- 探讨数字时代多媒体内容的形式和应用，如视频营销、互动内容等。\r\n- 强调多媒体内容对于提升用户体验和传播效果的价值。\r\n#### 2.3.3 用户参与与UGC生成\r\n- 讨论用户参与营销的形式，如UGC内容创作、社交互动等。\r\n- 强调用户参与对于品牌认知度和口碑传播的重要影响。\r\n### 2.4 社交媒体运营策略\r\n#### 2.4.1 不同社交平台特点与选型\r\n- 介绍主流社交平台的特点和受众特征，帮助企业选择合适的社交渠道。\r\n- 强调定制化社交内容对于平台运营的重要性。\r\n#### 2.4.2 社交内容发布与管理\r\n- 提供社交媒体内容发布的最佳实践，如时间选择、互动频率等。\r\n- 探讨社交内容管理对于维护品牌形象的重要性。\r\n#### 2.4.3 社交广告与合作推广\r\n- 强调社交广告在数字营销中的地位和广泛应用。\r\n- 探讨与KOL、意见领袖的合作，增强品牌影响力。\r\n### 2.5 数据分析与效果优化\r\n#### 2.5.1 关键指标设定与数据收集\r\n- 提供数字营销中关键指标的选择和设定原则，如转化率、点击率等。\r\n- 强调数据收集对于优化策略和效果评估的重要性。\r\n#### 2.5.2 数据分析与解读\r\n- 探讨数据分析方法，帮助企业了解营销活动的效果和用户反馈。\r\n- 强调数据解读对于调整营销策略的决策支持。\r\n#### 2.5.3 优化措施与A/B测试\r\n- 提供优化营销策略的具体措施，如优化内容、调整投放时段等。\r\n- 探讨A/B测试在数字营销中的应用，帮助找出最佳方案。\r\n\r\n## 3. 文案创作与传播\r\n### 3.1 文案风格与营销目的\r\n#### 3.1.1 标语、口号与广告文案\r\n- 探讨标语、口号和广告文案的特点和创作原则。\r\n- 强调文案在传递品牌核心信息和吸引目标受众方面的重要作用。\r\n#### 3.1.2 故事化文案与情感营销\r\n- 强调通过故事化文案传递品牌故事，引起用户共鸣和情感共鸣。\r\n- 讨论情感营销在数字时代的效果和注意事项。\r\n### 3.2 内容传播与媒体选择\r\n#### 3.2.1 不同渠道的适用性与特点\r\n- 提供不同传播渠道的特点和优势，如社交媒体、搜索引擎、电子邮件等。\r\n- 强调根据目标受众和营销目的选择合适的传播渠道。\r\n#### 3.2.2 KOL与意见领袖合作\r\n- 讨论与KOL、意见领袖的合作方式和效果。\r\n- 强调借助KOL影响力提升内容传播范围和品牌认知度。\r\n### 3.3 文案在不同媒体的应用\r\n#### 3.3.1 网站与Landing Page文案\r\n- 强调网站和Landing Page文案对于引导用户行为和提高转化率的重要性。\r\n- 讨论如何优化网站文案结构和内容呈现形式。\r\n#### 3.3.2 社交媒体文案\r\n- 探讨在社交媒体平台上的文案创作特点和技巧。\r\n- 强调社交媒体文案的简洁性和吸引力。\r\n#### 3.3.3 广告文案与宣传资料\r\n- 提供广告文案和宣传资料的创作指导，如海报、宣传册等。\r\n- 强调广告文案在吸引目标受众和传递核心信息方面的重要作用。\r\n\r\n## 4. 移动营销与新技术应用\r\n### 4.1 移动端营销策略\r\n#### 4.1.1 APP营销与用户留存\r\n- 讨论在移动端推广APP的策略，如ASO、用户留存等。\r\n- 强调移动端用户体验对于APP营销的关键影响。\r\n#### 4.1.2 移动搜索与推广\r\n- 提供移动搜索引擎优化和广告推广的方法和技巧。\r\n- 强调移动搜索在数字时代的重要性。\r\n### 4.2 AR/VR与营销创意\r\n#### 4.2.1 AR/VR技术简介\r\n- 介绍AR/VR技术在数字营销中的应用潜力和优势。\r\n- 强调AR/VR技术对于提升用户体验和品牌互动的重要性。\r\n#### 4.2.2 AR/VR在营销中的应用案例\r\n- 提供AR/VR在不同行业的成功应用案例，如虚拟试衣、增强现实广告等。\r\n- 探讨AR/VR为营销带来的创新机遇。\r\n### 4.3 AI与个性化推荐\r\n#### 4.3.1 智能推荐算法原理\r\n- 解释智能推荐算法的基本原理，如协同过滤、内容推荐等。\r\n- 强调个性化推荐对于提高用户满意度和购买转化率的重要性。\r\n#### 4.3.2 个性化推荐营销实践\r\n- 探讨数字时代个性化推荐在电商和内容营销中的应用案例。\r\n- 强调AI技术对于营销策略的智能化和精准化。\r\n\r\n## 5. 法律与伦理问题\r\n### 5.1 数字营销法律法规\r\n#### 5.1.1 隐私保护与用户数据收集\r\n- 强调企业在数字营销中需要遵守隐私保护法律法规，保护用户数据安全。\r\n- 探讨用户数据收集的合规性和可行性。\r\n#### 5.1.2 广告法规与虚假宣传防范\r\n- 介绍广告法规对于虚假宣传的规定和处罚措施。\r\n- 强调数字营销中避免虚假宣传的重要性。\r\n### 5.2 伦理问题与社会责任\r\n#### 5.2.1 虚假信息与不良引导\r\n- 探讨数字营销中存在的虚假信息和不良引导问题，如网络谣言、不当营销手段等。\r\n- 强调企业应承担社会责任，避免不良营销行为。\r\n#### 5.2.2 社交媒体责任与舆论引导\r\n- 强调社交媒体平台对于内容审查和舆论引导的责任。\r\n- 讨论如何在数字营销中避免误导用户和参与不正当竞争。\r\n\r\n## 6. 未来展望与趋势预测\r\n### 6.1 数字营销趋势\r\n#### 6.1.1 新兴技术与平台发展\r\n- 探讨未来数字营销可能涌现的新兴技术和数字平台。\r\n- 强调企业需要紧跟科技发展趋势，不断创新和优化营销策略。\r\n#### 6.1.2 用户行为与消费习惯变化\r\n- 分析数字时代用户行为和消费习惯的变化趋势。\r\n- 强调数字营销需要因势利导，根据用户需求不断调整策略。\r\n### 6.2 可持续发展与社会影响\r\n#### 6.2.1 环境保护与绿色营销\r\n- 强调绿色营销在数字时代的重要性，如绿色产品推广和环保宣传。\r\n- 讨论数字营销如何促进企业可持续发展和环境保护。\r\n#### 6.2.2 社会责任与公益营销\r\n- 探讨企业在数字时代积极履行社会责任的策略，如公益合作、社会公益活动等。\r\n- 强调公益营销对于塑造正面企业形象和提升品牌声誉的意义。\r\n\r\n## 7. 成功案例分析\r\n### 7.1 行业领先者的数字营销策略\r\n- 分析行业领先企业在数字营销方面的成功策略和经验。\r\n- 强调成功案例对于其他企业借鉴和学习的重要价值。\r\n### 7.2 创意文案在营销中的应用\r\n- 探讨创意文案在数字营销中的应用效果和优势。\r\n- 强调创意在营销中的价值和创新性。\r\n### 7.3 移动营销与新技术成功案例\r\n- 分析移动营销和新技术应用在数字时代的成功案例。\r\n- 强调数字营销创新和技术应用对于企业竞争优势的重要性。\r\n\r\n## 8. 总结与实战指南\r\n### 8.1 重要观点与实践经验总结\r\n- 总结数字时代营销策划和文案创作的重要观点和核心理念。\r\n- 强调实践经验对于提高营销效果的重要性。\r\n### 8.2 制定数字营销策略的步骤与方法\r\n- 提供制定数字营销策略的具体步骤和方法，如市场调研、目标定位等。\r\n- 强调制定策略时需要综合考虑不同因素。\r\n### 8.3 营销文案创作的关键要素\r\n- 总结营销文案创作的关键要素，如定位清晰、语言简洁等。\r\n- 探讨如何根据目标受众和营销目的创作有效文案。\r\n### 8.4 营销效果监测与优化建议\r\n- 提供营销效果监测的指标和方法，以及优化建议。\r\n- 强调数据驱动优化策略的重要性，不断改进营销效果。"
    },
    "msg": "查询成功"
}

上一篇：阿里AI通义千问api python开发文档

下一篇：百度文心一言api 调用ERNIE-3.5-8K，Python技术开发文档

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

type	操作的相关事件(可具体参考下列相关事件)
data	操作的相关事件返回的内容信息(可具体参考下列相关事件)

输入标题前置鉴权	SCENE_AUTH	{ scene: 1001 title: 手动输入的标题
点击预置词前置鉴权	SCENE_AUTH	{ scene: 1002 title: 预置词标题
上传word前置鉴权	SCENE_AUTH	{ scene: 1003 title: 上传的文件名称
上传xmind前置鉴权	SCENE_AUTH	{ scene: 1004 title: 上传的文件名称
上传freemind前置鉴权	SCENE_AUTH	{ scene: 1005 title: 上传的文件名称
上传markdown前置鉴权	SCENE_AUTH	{ scene: 1006 title: 上传的文件名称
粘贴markdown前置鉴权	SCENE_AUTH	{ scene: 1007 title: 固定名称"粘贴markdown"
换个大纲前置鉴权	SCENE_AUTH	{ scene: 1021 title: 标题名称 taskId: 任务id
下载大纲md文件前置鉴权	SCENE_AUTH	{ scene: 1022 title: 标题名称 (除AI和word生成外，其他类型下载文件名称和title不匹配) taskId: 任务id
下载大纲图片前置鉴权	SCENE_AUTH	{ scene: 1023 title: 标题名称 (除AI和word生成外，其他类型下载文件名称和title不匹配) taskId: 任务id
下一步选择模板前置鉴权	SCENE_AUTH	{ scene: 1024 title: 标题名称 (除AI和word生成外，其他类型下载文件名称和title不匹配) taskId: 任务id
生成PPT前置鉴权	SCENE_AUTH	{ scene: 1024 title: 标题名称 (除AI和word生成外，其他类型下载文件名称和title不匹配) taskId: 任务id
生成PPT前置鉴权	SCENE_AUTH	{ scene: 1026 title: 标题名称 taskId: 任务id id: 作品ID
生成PPT页面下载功能前置鉴权	SCENE_AUTH	{ scene: 1027 title: 标题名称 id: 作品ID taskId: 任务id
编辑器页面下载功能前置鉴权	SCENE_AUTH	{ scene: 1028 title: 标题名称 id: 作品ID taskId: 任务id
编辑器页面导出拼图功能前置鉴权	SCENE_AUTH	{ scene: 1029 title: 标题名称 id: 作品ID taskId: 任务id