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