有一云AI OpenAPI 使用帮助

1. 当前仅开放了公众号相关的个别API，后续将会陆续开放更多场景；

2. 2025年 5 月1日前，有一云开放 API 可免费调用（token消耗随账户），后续收费开始时间及收费策略待定。

 

场景一、智能写作+排版+发布业务流程

1. token：获取并保存 AccessToken（有效期 30 分钟，自行保存）

2. post/create：根据提示词，生成排版好的文章

3. post/task/query：根据 TaskID 查询文章，获取文章 PostID，因创作、配图均有一定的时间消耗，建议 2-5 分钟后调用

4. post/settings/save：如需要自行设置文章封面、作者、摘要等信息，可以对文章属性进行设置，也可以忽略本接口，由系统自动提取

5. post/mp/sync：同步/发布文章

 

场景二、Markdown+排版+发布业务流程

1. token：获取并保存 AccessToken（有效期 30 分钟，自行保存）

2. post/markdown/create：根据提供的 Markdown 原始文本，生成排版好的文章

3. post/task/query：根据 TaskID 查询文章，获取文章 PostID，因配图有一定的时间消耗，建议 1 分钟后调用

4. post/settings/save：如需要自行设置文章封面、作者、摘要等信息，可以对文章属性进行设置，也可以忽略本接口，由系统自动提取

5. post/mp/sync：同步/发布文章

 

获取 API KEY

在用户中心页面，点击 “API KEYS” 菜单，进入 API KEYS 设置界面，点击 “创建 API KEY” 按钮，即可生成接口调用所需的 API KEY。

 

使用 API KEY 换取 AccessToken

接口地址：https://open.uecloud.com/token

请求方式：POST

注意事项：接口有调用次数限制，建议获取 AccessToken 之后，自行缓存，在必要时再去刷新

 

入参：

参数名称	类型	是否必填	默认值	说明
api_key	String	是		您的 API KEY

 

输出结果：

参数名称	类型	说明
access_token	String	调用凭证，后续请求均使用该 token 作为身份凭证
expires_in	Number	过期时间，单位秒，默认 token 有效期为 30 分钟，即：1800 秒

 

入参示例

{
  api_key: 'xxx',
}

 

输出示例

{
  "code": 0,
  "data": {
    "access_token": "xxx",
    "expires_in": 1800
  }
}

 

根据提示词，生成排版好的文章（适用于场景一）

接口地址：https://open.uecloud.com/post/create?access_token=[Your Access Token]

请求方式：POST

注意事项：接口有调用频率限制，建议两次调用之间的事件间隔大于 2 分钟

 

入参：

参数名称	类型	是否必填	默认值	说明
keyword	String	是		提示词，最多支持 500 字
content_type	String	否	article	生成的文章类型，可选值有： article（文章）、microArticle（笔记）
model_id	String	否	ChatGLM	使用的模型ID，可选值有：ChatGLM / DeepSeek，也可以填写自有模型
template_id	String	否		自定义模板ID，不传则表示AI自动生成
painting	Boolean	否	false	是否需要配图
thumbs	String[]	否		文章配图来源 仅支持在有一云AI图片管理器中上传的图片 如果不传，则自动配图，如果传，则文中配图从该列表中随机填充 推荐传递多个，可以减少重复率
biz_params	Object	否		用户业务参数，可以是任意可序列化的 json 对象

 

输出结果：

参数名称	类型	说明
task_id	String	任务 ID

入参示例

{
  keyword: '新媒体赚钱',
  content_type: 'article',
  model_id: '',
  template_id: 'xxx',
  painting: true,
  thumbs: [
    'https://s.uecloud.com.cn/xxx/xxx.jpg',
    'https://s.uecloud.com.cn/yyy/yyy.jpg'
  ],
  biz_params: {}
}

 

输出示例

{
  "code": 0,
  "data": {
    "task_id": "DP",
  }
}

 

根据提供的 Markdown 文本，生成排版好的文章（适用于场景二）

接口地址：https://open.uecloud.com/post/markdown/create?access_token=[Your Access Token]

请求方式：POST

注意事项：接口有调用频率限制，建议两次调用之间的事件间隔大于 2 分钟

 

入参：

参数名称	类型	是否必填	默认值	说明
markdown	String	是		提示词，最多支持 5,000 字
template_id	String	否		自定义模板ID，不传则表示AI自动生成
painting	Boolean	否	false	是否需要配图，如需配图，请在 Markdown 中使用图片占位表示，详情见入参示例
thumbs	String[]	否		文章配图来源 仅支持在有一云AI图片管理器中上传的图片 如果不传，则自动配图，如果传，则文中配图从该列表中随机填充 推荐传递多个，可以减少重复率
biz_params	Object	否		用户业务参数，可以是任意可序列化的 json 对象

 

输出结果：

参数名称	类型	说明
task_id	String	任务 ID

入参示例

{
  markdown: '# 新媒体赚钱\n\n##标题1\n\n内容1\n\n## 标题2\n\n内容2\n\n![美元]()',
  template_id: 'xxx',
  painting: true,
  thumbs: [
    'https://s.uecloud.com.cn/xxx/xxx.jpg',
    'https://s.uecloud.com.cn/yyy/yyy.jpg'
  ],
  biz_params: {}
}

 

输出示例

{
  "code": 0,
  "data": {
    "task_id": "DP",
  }
}

 

根据 task_id 查询文章

接口地址：https://open.uecloud.com/post/task/query?access_token=[Your Access Token]

请求方式：POST

 

入参：

参数名称	类型	是否必填	默认值	说明
task_id	String	是		任务 ID

 

输出结果：

参数名称	类型	说明
task_id	String	任务 ID
post_id	String	文章 ID
content_type	String	同入参
biz_params	Object	同入参
html	String	排版后的文章HTML
status	Number	任务状态，0：撰写中，1：配图中，2：排版中，9：已完成，-1：失败
failed_reason	String	失败原因

 

入参示例

{
  task_id: 'xxx',
}

 

输出示例

{
  "code": 0,
  "data": {
    "task_id": "xxx",
    "post_id": "xxx",
    "content_type": "article",
    "biz_params": {},
    "html": "...",
    "status": 9,
    "failed_reason": ""
  }
}

 

根据 PostID 设置文章属性

接口地址：https://open.uecloud.com/post/settings/save?access_token=[Your Access Token]

请求方式：POST

注意事项：仅支持图文消息类型（article），微信笔记（图片/文字）不支持

 

入参：

参数名称	类型	是否必填	默认值	说明
post_id	String	是		文章 ID
settings	Object	是		文章属性
settings.author	String	否		文章作者
settings.digest	String	否		文章摘要，不填则自动从文中提取
settings.thumb	String	否		文章封面，不填则自动从文中提取 仅支持在有一云AI图片管理器中上传的图片
settings.need_open_comment	Boolean	否		是否开启评论，要确认公众号是否拥有开启留言的权限，如未获得留言权限，请勿传递此参数，否则会同步失败
settings.only_fans_can_comment	Boolean	否		是否仅粉丝可评论，注意事项同上
settings.content_source_url	String	否		原文 URL

 

输出结果：true | false

 

入参示例

{
  post_id: 'xxx',
  settings: {
    author: '有一云AI',
    digest: '这里是文章摘要这里是文章摘要',
    thumb: 'https://s.uecloud.com.cn/xxx/xxx.jpg',
    need_open_comment: false,
    only_fans_can_comment: false,
    content_source_url: 'https://www.uecloud.com/'
  }
}

 

输出示例

{
  "code": 0,
  "data": true
}

 

将文章发布至公众号（或同步至草稿箱）

接口地址：https://open.uecloud.com/post/mp/sync?access_token=[Your Access Token]

请求方式：POST

注意事项：接口有调用频率限制，请勿频繁调用

 

入参：

参数名称	类型	是否必填	默认值	说明
appid	String	是		公众号appid，必须在有一云平台绑定授权，可在 公众号 - 账号管理 - 进入管理页面查看APPID
posts	Array	是		要同步的文章列表，至少1条，最多8条
posts[].post_id	String	是		文章ID
sync_type	String	否	Draft	动作类型，Draft：放入草稿，Publish：发布

 

输出结果：true | false

 

入参示例

{
  appid: 'xxx',
  sync_type: 'Draft',
  posts: [{
    post_id: 'xxx',
  }, {
    post_id: 'yyy',
  }]
}

 

输出示例

{
  "code": 0,
  "data": true
}