本产品（
AI妙笔/2023-08-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
通用接口
| API | 标题 | API概述 |
|---|---|---|
| CreateToken | 获取授权token | 创建在线推理API的临时Token。 |
| ListDialogues | 生成历史列表 | 在线推理场景的历史记录。 |
| ListVersions | 获取版本信息 | 获取用户购买的版本信息。 |
| GetProperties | 获取配置信息 | 获取配置信息。包括不限于智能配置的风格，推理相关元数据配置等。 |
通用接口-文件上传下载
| API | 标题 | API概述 |
|---|---|---|
| GenerateFileUrlByKey | 生成文件URL | 生成临时可访问的公开url。 |
| GenerateUploadConfig | 生成上传配置 | 生成文件上传配置。 |
通用接口-异步任务管理
| API | 标题 | API概述 |
|---|---|---|
| SubmitAsyncTask | 提交异步任务 | 执行系统预定义的异步任务。 |
| CancelAsyncTask | 取消异步任务 | 取消已提交，尚未执行完成的异步任务。 |
| QueryAsyncTask | 查询异步任务明细 | 查询已提交异步任务执行明细。 |
| ListAsyncTasks | 获取异步任务列表 | 获取异步任务列表。 |
妙笔-创作文章
| API | 标题 | API概述 |
|---|---|---|
| SearchNews | 信息检索 | 信息检索。 |
| ListBuildConfigs | 获取系统自定义预设 | 获取系统自定义预设。 |
| GenerateImageTask | 生成智能配图任务 | 智能配图，图片生成任务。 |
| FetchImageTask | 获取图片任务执行结果 | |
| FeedbackDialogue | 反馈对话 | 反馈生成的对话。 |
妙笔-创作文章-自定义文本
| API | 标题 | API概述 |
|---|---|---|
| GetCustomText | 获取自定义文本 | 获取自定义文本。 |
| UpdateCustomText | 更新自定义文本 | 更新自定义文本。 |
| ListCustomText | 获取自定义文本列表 | 获取自定义文本列表。 |
| SaveCustomText | 保存自定义文本 | 保存自定义文本。 |
| DeleteCustomText | 删除自定义文本 | 删除自定义文本。 |
| DocumentExtraction | 文档提取 | 从链接中提取文档内容。 |
妙笔-文档管理
| API | 标题 | API概述 |
|---|---|---|
| CreateGeneratedContent | 保存文档 | 保存文档：用来保存妙笔中创作的文章，支持富文本。 |
| DeleteGeneratedContent | 删除文档 | 删除文档：用来删除妙笔中创作的文章。 |
| UpdateGeneratedContent | 更新文档 | 更新文档：用来更新妙笔中创作的文章历史。 |
| GetGeneratedContent | 获取文档 | 获取文档：用来查询妙笔中创作的文章历史。 |
| ListGeneratedContents | 获取文档列表 | 获取文档列表：用来查询妙笔中创作的文章历史列表。 |
| ExportGeneratedContent | 导出文档 | 导出文档：用来导出妙笔中创作的文章历史。 |
妙笔-素材库
| API | 标题 | API概述 |
|---|---|---|
| SaveMaterialDocument | 保存素材 | 保存素材：保存素材库中素材。 |
| DeleteMaterialById | 删除素材 | 删除素材：删除素材库中素材。 |
| UpdateMaterialDocument | 更新素材 | 更新素材：更新素材库中素材。 |
| GetMaterialById | 获取素材 | 获取素材：获取素材库中素材详细信息。 |
| ListMaterialDocuments | 获取素材列表 | 获取素材列表：获取素材库中素材列表。 |
妙策-选题热点
| API | 标题 | API概述 |
|---|---|---|
| ListHotNewsWithType | 获取选题热点列表 | 获取选题热点列表。 |
| GenerateViewPoint | 生成选题视角 | 生成选题视角。 |
系统配置-干预配置
| API | 标题 | API概述 |
|---|---|---|
| ListInterveneCnt | 获得所有干预项的数量 | 获得干预项目数量列表。 |
| ListIntervenes | 列出干预项 | 获得干预项列表。 |
| ImportInterveneFile | 同步导入干预项文件 | 导入干预文件。 |
| InsertInterveneGlobalReply | 插入干预全局回复项 | 设置干预全局回复。 |
| ImportInterveneFileAsync | 异步导入干预项文件 | 异步导入干预文件。 |
| GetInterveneTemplateFileUrl | 获得干预导入模版文件地址 | 获得干预导入模版文件下载地址。 |
| ClearIntervenes | 清除所有干预项 | 清除所有干预内容。 |
| GetInterveneGlobalReply | 获得干预全局回复内容 | 获得干预全局回复。 |
| ListInterveneRules | 列出干预规则 | 获得干预规则列表。 |
| ListInterveneImportTasks | 列出干预项导入任务 | 获得导入任务列表。 |
| InsertInterveneRule | 插入干预规则 | 插入干预规则。 |
| GetInterveneRuleDetail | 获得干预规则的详情 | 获得干预项规则详情。 |
| DeleteInterveneRule | 删除干预规则 | 删除干预规则。 |
| ExportIntervenes | 导出干预项内容 | 导出所有干预内容。 |
| GetInterveneImportTaskInfo | 获得干预项目导入任务信息 | 获得导入任务信息。 |
系统配置-信源管理
| API | 标题 | API概述 |
|---|---|---|
| SaveDataSourceOrderConfig | 保存信源权重配置 | 保存用户写作信源配置，通用搜索信源配置的配置信息。 |
| GetDataSourceOrderConfig | 获取信源配置权重数据 | 获取写作信源，通用搜索信源的配置信息。 |