文章/内容管理
说明:通过查询素材与目录列表选择素材后,可将素材 ID 填入生成文章的 knowledge_ids。文章及标签查询参见获取文章列表和获取团队下的文章标签。
获取团队下的文章标签
- 请求方法:POST
- 请求路径:
/geo/article/tag/get
说明:此接口返回文章标签,不返回用户提问标签或模型标签。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| team_id | string | 团队ID | 是 |
| tag_type | int 数组 | 标签类型筛选:1-用户标签,2-系统标签;空数组表示不按类型筛选 | 否 |
响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| tag_id | string | 标签ID |
| team_id | string | 团队ID |
| name | string | 标签名称 |
| note | string | 标签备注 |
| tag_type | int | 标签类型:1-用户标签,2-系统标签 |
| status | int | 标签状态:1-启用,2-禁用 |
| created_by | string | 创建人 |
| article_count | int | 标签关联的文章数 |
| created_time | int64 | 创建时间 |
响应示例:
{
"code": 0,
"msg": "success",
"data": [
{
"tag_id": "tag_test_001",
"team_id": "team_test_001",
"name": "测试标签A",
"note": "测试标签备注",
"tag_type": 1,
"status": 1,
"created_by": "test_user",
"article_count": 10,
"created_time": "1735689600000"
}
]
}新建文章并加入追踪
- 请求方法:POST
- 请求路径:
/geo/article/trace/save
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| brand_id | string | 品牌ID | 是 |
| title | string | 文章标题 | 是 |
| urls | string 数组 | 文章的各个发布链接 | 是 |
| tag_ids | string 数组 | 文章需要关联的标签ID | 否 |
| language | string | 文章语言,使用 BCP 47 语言码;默认 zh-CN。支持:zh-CN、zh-SG、zh-TW、zh-HK、zh-MO、en-US、en-GB、ja-JP、ko-KR、fr-FR、de-DE、es-ES、pt-BR、pt-PT、it-IT、th-TH、vi-VN、id-ID、ar-SA、ru-RU、ms-MY | 否 |
返回参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| article_id | string | 文章ID |
响应示例:
{
"code": 0,
"msg": "success",
"data": "article_test_001"
}获取文章列表
- 请求方法:POST
- 请求路径:
/geo/article/query
说明:
- 该接口用于获取品牌下的文章列表,并返回文章维度的汇总引用数据。
- 如果只需要导出文章维度的引用总数、引用趋势、已发布平台等信息,该接口可以直接满足。
- 如果需要按 AI 平台拆分的引用明细,需要先通过该接口获取
article_id,再调用「获取文章追踪详情」。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| brand_id | string | 品牌ID | 是 |
| limit | int | 每次返回数量;不传默认 20 | 否 |
| scroll_id | string | 游标;翻页时传上一次响应中的 scroll_id | 否 |
| start_time | int64 | 引用统计开始时间,毫秒时间戳 | 否 |
| end_time | int64 | 引用统计结束时间,毫秒时间戳 | 否 |
| title | string | 文章标题关键字 | 否 |
| status | int 数组 | 文章状态列表 | 否 |
| source | int 数组 | 文章来源列表 | 否 |
| template_type | int 数组 | 文章模板类型列表 | 否 |
| tag_ids | string 数组 | 标签ID列表 | 否 |
| ref_order_type | int | 引用数排序:1-升序,2-降序 | 否 |
| language | string 数组 | 文章语言列表,使用 BCP 47 语言码 | 否 |
| has_video | bool | 是否筛选已生成视频的文章 | 否 |
| has_video_generating | bool | 是否筛选视频生成中的文章 | 否 |
响应参数:
| 返回值 | 类型 | 含义 | |
|---|---|---|---|
| list | object 数组 | 文章列表 | |
| list.id | string | 文章ID | |
| list.brand_id | string | 品牌ID | |
| list.title | string | 文章标题 | |
| list.status | int | 文章状态 | |
| list.source | int | 文章来源 | |
| list.template_type | int | 文章模板类型 | |
| list.ref_count | int | 当前筛选时间范围内的文章引用总数 | |
| list.fluctuation | float | 引用数变化值 | |
| list.ref_trends | object 数组 | 文章引用趋势 | |
| list.ref_trends.date | string | 日期,格式:YYYY-MM-DD | |
| list.ref_trends.count | int | 当日引用数 | |
| list.published_platforms | object 数组 | 文章已发布平台 | |
| list.published_platforms.platform | string | 发布平台标识 | |
| list.published_platforms.display_name | string | 发布平台展示名 | |
| list.published_platforms.icon_url | string | 发布平台图标 | |
| list.published_platforms.publish_url | string | 发布链接 | |
| scroll_id | string | 下一页游标;为空表示没有更多数据 | |
| total | int | 匹配文章总数 | |
| total_links | int | 匹配文章的发布链接总数 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": "article_test_001",
"brand_id": "brand_test_001",
"title": "测试文章A",
"status": 1,
"source": 1,
"template_type": 1,
"ref_count": 12,
"fluctuation": 3,
"ref_trends": [
{
"date": "2026-01-15",
"count": 4
}
],
"published_platforms": [
{
"platform": "wechat",
"display_name": "微信公众号",
"icon_url": "https://static.example.com/platform/wechat.png",
"publish_url": "https://example.com/article/a"
}
]
}
],
"scroll_id": "12:article_test_001",
"total": 1,
"total_links": 1
}
}获取文章追踪详情
- 请求方法:POST
- 请求路径:
/geo/article/trace/detail
说明:
- 该接口用于获取单篇追踪文章的引用详情,包含按 AI 平台拆分的引用次数和趋势。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| article_id | string | 文章ID | 是 |
| begin_date | string | 开始日期,格式:YYYY-MM-DD;不传则按系统默认统计范围 | 否 |
| end_date | string | 结束日期,格式:YYYY-MM-DD;传入时需与 begin_date 同时传入 | 否 |
响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| trace_info | object 数组 | 文章追踪记录列表;一篇文章可对应多个发布链接 |
| trace_info.trace_id | string | 追踪记录ID |
| trace_info.article_id | string | 文章ID |
| trace_info.url | string | 追踪链接 |
| trace_info.platform | string | 发布平台 |
| trace_info.icon | string | 发布平台图标 |
| trace_info.title | string | 文章标题 |
| trace_info.can_edit | bool | 当前追踪链接是否允许编辑 |
| trace_info.stats | object | 当前追踪链接的引用统计 |
| stats | object | 文章整体引用统计 |
| stats.ref_count | object | 按 AI 平台统计的引用次数,key 为平台标识,value 为引用次数 |
| stats.total_count | int | 引用总数 |
| stats.ref_count_increase | int | 引用增长数 |
| stats.ref_trends | object 数组 | 按 AI 平台拆分的引用趋势 |
| stats.ref_trends.platform | string | AI 平台标识 |
| stats.ref_trends.ref_trends | object 数组 | 该平台下的每日引用趋势 |
| stats.ref_trends.ref_trends.date | string | 日期,格式:YYYY-MM-DD |
| stats.ref_trends.ref_trends.ref_count | int | 当日引用数 |
| stats.ref_trends.ref_trends.prompts | object 数组 | 产生引用的用户提问列表 |
| stats.ref_trends.ref_trends.prompts.prompt_id | string | 用户提问ID |
| stats.ref_trends.ref_trends.prompts.prompt_content | string | 用户提问内容 |
| stats.ref_trends.ref_trends.prompts.title_name | string | 用户提问分类名称 |
| stats.ref_trends.ref_trends.prompts.ref_count | int | 该用户提问产生的引用数 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"trace_info": [
{
"trace_id": "trace_test_001",
"article_id": "article_test_001",
"url": "https://example.com/article/a",
"platform": "wechat",
"icon": "https://static.example.com/platform/wechat.png",
"title": "测试文章A",
"can_edit": false,
"stats": {
"ref_count": {
"deepseek": 4,
"yuanbao": 2
},
"total_count": 6
}
}
],
"stats": {
"ref_count": {
"deepseek": 8,
"yuanbao": 4
},
"total_count": 12,
"ref_count_increase": 3,
"ref_trends": [
{
"platform": "deepseek",
"ref_trends": [
{
"date": "2026-01-15",
"ref_count": 4,
"prompts": [
{
"prompt_id": "prompt_test_001",
"prompt_content": "测试品牌A适合哪些业务场景?",
"title_name": "测试分类A",
"ref_count": 2
}
]
}
]
}
]
}
}
}保存粘贴正文或客户端解析的文章
- 请求方法: POST
- 请求路径:
/geo/article/upload
说明:main_body 接收文章正文。导入本地文件时需先由客户端解析为正文,再以 JSON 提交;不接收原始文件或 multipart 表单。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
title | string | 非空文章标题。 | 是 |
main_body | string | 非空文章正文。 | 是 |
tag_ids | string 数组 | 可选标签,须属于品牌所在团队。 | 否 |
language | string | BCP 47 语言码;默认 zh-CN,支持列表见“生成文章”。 | 否 |
请求示例:
{
"brand_id": "2072208110612647936",
"title": "测试文章A",
"main_body": "# 测试文章A\n\n这是测试文章A的正文。",
"tag_ids": [
"2072208110612647940"
],
"language": "en-US"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data.id | string | 保存成功的文章 ID。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"id": "2072208110612647937"
}
}修改文章标题和正文
- 请求方法: POST
- 请求路径:
/geo/article/update
说明:仅已完成生成的文章可编辑,生成中的文章会返回错误;修改标题和正文不会改变素材引用。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
id | string | 文章 ID。 | 是 |
title | string | 完整新标题,必须非空。 | 是 |
main_body | string | 完整正文;省略时会按空正文写入,要保留内容需提交当前正文。 | 否 |
language | string | 可选 BCP 47 语言码;省略时保留原语言。 | 否 |
请求示例:
{
"brand_id": "2072208110612647936",
"id": "2072208110612647937",
"title": "测试文章A(已更新)",
"main_body": "# 测试文章A(已更新)\n\n这是测试文章A更新后的正文。",
"language": "en-US"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
响应示例:
{
"code": 0,
"msg": "success"
}创建文章标签
- 请求方法: POST
- 请求路径:
/geo/article/tag/create
说明:新建标签默认 status=2(禁用);如需启用,通过更新文章标签将 status 设为 1。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
team_id | string | 团队 ID。 | 是 |
name | string | 非空标签名称;同团队不能重名。 | 是 |
note | string | 备注。 | 否 |
请求示例:
{
"team_id": "2072208110612647939",
"name": "测试标签A",
"note": "测试说明"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 新建标签。 |
data.tag_id | string | 标签 ID。 |
data.team_id | string | 所属团队 ID。 |
data.name | string | 标签名称。 |
data.note | string | 标签备注。 |
data.tag_type | int | 1:用户标签;2:系统标签。 |
data.status | int | 1:启用;2:禁用。 |
data.created_by | string | 创建人显示名。 |
data.article_count | int | 关联文章数量。 |
data.created_time | int64 | 创建时间,Unix 毫秒;可能以字符串表示。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"tag_id": "2072208110612647940",
"team_id": "2072208110612647939",
"name": "测试标签A",
"note": "测试说明",
"tag_type": 1,
"status": 2,
"created_by": "测试用户A",
"article_count": 0,
"created_time": "1791936000000"
}
}更新文章标签
- 请求方法: POST
- 请求路径:
/geo/article/tag/update
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
team_id | string | 团队 ID。 | 是 |
tag_id | string | 标签 ID。 | 是 |
name | string | 非空的新名称。 | 是 |
note | string | 完整备注;省略时按空字符串更新。 | 否 |
status | int | 1:启用;2:禁用;不可省略为 0。 | 是 |
请求示例:
{
"team_id": "2072208110612647939",
"tag_id": "2072208110612647940",
"name": "测试标签A",
"note": "测试说明",
"status": 1
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 成功时为空对象。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {}
}批量删除文章标签
- 请求方法: POST
- 请求路径:
/geo/article/tag/delete
说明:仍有关联文章的标签不能删除。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
team_id | string | 团队 ID。 | 是 |
tag_ids | string 数组 | 待删除标签 ID,不能为空。 | 是 |
请求示例:
{
"team_id": "2072208110612647939",
"tag_ids": [
"2072208110612647940"
]
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 成功时为空对象。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {}
}获取文章模板
- 请求方法:POST
- 请求路径:
/geo/article/template/get
说明:
- 该接口用于获取当前可用的文章模板列表,建议在调用「生成文章」前使用。
template_id即创建文章时的template_type。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| local_code | string | 模板说明语言,使用 BCP 47 语言码;默认 zh-CN | 否 |
响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| template_id | int | 模板类型ID |
| template_name | string | 模板名称 |
| description | string | 模板描述 |
| is_high_ref | int | 是否高引用模板:0-否,1-是。为 1 时,生成文章需传入 high_ref |
响应示例:
{
"code": 0,
"msg": "success",
"data": [
{
"template_id": 1,
"template_name": "品牌介绍",
"description": "适用于品牌与产品介绍",
"is_high_ref": 0
}
]
}生成文章
- 请求方法:POST
- 请求路径:
/geo/article/create
说明:
- 该接口用于提交文章生成任务。接口返回成功仅表示任务已受理,不表示正文已生成完成。
- 如需在平台内持续追踪发布后的引用效果,可继续调用「新建文章并加入追踪」。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| brand_id | string | 品牌ID | 是 |
| template_type | int | 文章模板类型,可通过「获取文章模板」取得 | 是 |
| prompt_ids | string 数组 | 用户提问ID列表,最多 20 个 | 是 |
| knowledge_ids | string 数组 | 参考素材ID列表,最多 20 个 | 否 |
| once_knowledge | string | 本次生成使用的补充资料 | 否 |
| high_ref | object | 高引用模板的参考文章;is_high_ref=1 时必填 | 条件必填 |
| high_ref.url | string | 参考文章链接;填写后无需再传标题和正文 | 否 |
| high_ref.title | string | 参考文章标题;未传链接时需与正文同时传入 | 否 |
| high_ref.content | string | 参考文章正文;未传链接时需与标题同时传入 | 否 |
| tag_ids | string 数组 | 文章需要关联的标签ID | 否 |
| language | string | 文章语言,使用 BCP 47 语言码;默认 zh-CN。支持:zh-CN、zh-SG、zh-TW、zh-HK、zh-MO、en-US、en-GB、ja-JP、ko-KR、fr-FR、de-DE、es-ES、pt-BR、pt-PT、it-IT、th-TH、vi-VN、id-ID、ar-SA、ru-RU、ms-MY | 否 |
响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| id | string | 文章ID |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"id": "article_test_001"
}
}获取文章内容
- 请求方法:POST
- 请求路径:
/geo/article/get
说明:
- 该接口用于获取单篇文章的标题和正文。
status=0表示仍在生成;status=1表示已生成、待发布。生成完成后,title与main_body可供自行发布。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
| brand_id | string | 品牌ID | 是 |
| article_id | string | 文章ID | 是 |
响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
| article_id | string | 文章ID |
| brand_id | string | 品牌ID |
| title | string | 文章标题 |
| main_body | string | 文章正文 |
| status | int | 文章状态:0-生成中,1-待发布,2-发布中,3-追踪中,4-失败 |
| template_type | int | 文章模板类型 |
| source | int | 文章来源:1-平台创作,2-用户创作 |
| language | string | 文章语言,使用 BCP 47 语言码 |
| tags | object 数组 | 文章关联标签 |
| tags.tag_id | string | 标签ID |
| tags.tag_name | string | 标签名称 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"article_id": "article_test_001",
"brand_id": "brand_test_001",
"title": "测试品牌A的核心能力与适用场景",
"main_body": "这里是生成完成的文章正文。",
"status": 1,
"template_type": 1,
"source": 1,
"language": "zh-CN",
"tags": [
{
"tag_id": "tag_test_001",
"tag_name": "产品介绍"
}
]
}
}提交文章自动发布
- 请求方法: POST
- 请求路径:
/geo/article/distribute
说明:成功响应表示已提交自动发布流程,发布结果通过查询品牌自动发布记录获取。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
article_id | string | 文章 ID。 | 是 |
platform | string | 发布平台标识,如 zhihu;须有当前可用渠道及配额。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937",
"platform": "zhihu"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 成功时为空对象。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {}
}发布选定的视频或图文素材
- 请求方法: POST
- 请求路径:
/geo/article/distribute/selected
说明:生成任务须已完成,并属于请求指定的文章和品牌。发布结果通过查询品牌自动发布记录获取。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
article_id | string | 文章 ID。 | 是 |
platform | string | 当前仅支持 douyin。 | 是 |
video_id | string | 视频或图文生成任务 ID(UUID)。 | 是 |
content_type | string | video 或 image_text;不传时从任务结果确定,传入时须与结果一致。 | 否 |
请求示例:
{
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937",
"platform": "douyin",
"video_id": "550e8400-e29b-41d4-a716-446655440000",
"content_type": "image_text"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 成功时为空对象。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {}
}解除文章发布链接关联
- 请求方法: POST
- 请求路径:
/geo/article/distribute/unbind
说明:仅解除文章与发布链接的关联,不删除外部平台上的文章。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
article_id | string | 文章 ID。 | 是 |
platform | string | 发布平台标识,可选。 | 否 |
publish_url | string | 文章已发布的完整 URL。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937",
"platform": "zhihu",
"publish_url": "https://www.zhihu.com/p/123456789"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 成功时为空对象。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {}
}查询品牌自动发布记录
- 请求方法: POST
- 请求路径:
/geo/article/distribute/list/records
说明:该接口按品牌查询自动发布记录。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
publish_status | int | 0 或省略为全部;1 发布中、2 成功、3 失败。 | 否 |
limit | int | 默认 20。 | 否 |
scroll_id | string | 记录 ID 游标;首次为 “0” 或省略。 | 否 |
请求示例:
{
"brand_id": "2072208110612647936",
"limit": 20,
"publish_status": 0,
"scroll_id": "0"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data.records | object 数组 | 发布记录列表。 |
data.records[].article_id | string | 文章 ID。 |
data.records[].title | string | 文章标题。 |
data.records[].record | object | 发布记录。 |
data.records[].record.record_id | string | 发布记录 ID。 |
data.records[].record.brand_id | string | 品牌 ID。 |
data.records[].record.article_id | string | 文章 ID。 |
data.records[].record.platform | string | 发布平台标识。 |
data.records[].record.publish_mode | int | 1:自动;2:手动。 |
data.records[].record.publish_status | int | 0:未知;1:发布中;2:成功;3:失败。 |
data.records[].record.publish_url | string | 发布链接。 |
data.records[].record.published_by | string | 操作人显示名。 |
data.records[].record.error_msg | string | 失败说明。 |
data.records[].record.error_screenshot_url | string | 失败截图地址。 |
data.records[].record.created_time | int64 | 创建时间,Unix 毫秒;可能以字符串表示。 |
data.records[].record.updated_time | int64 | 更新时间,Unix 毫秒;可能以字符串表示。 |
data.scroll_id | string | 下一页记录游标。 |
data.has_more | bool | 是否还有下一页。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"records": [
{
"article_id": "2072208110612647937",
"title": "测试文章A",
"record": {
"record_id": "2072208110612647943",
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937",
"platform": "zhihu",
"publish_mode": 1,
"publish_status": 2,
"publish_url": "https://example.com/published/test-article-a",
"published_by": "测试用户A",
"error_msg": "",
"error_screenshot_url": "",
"created_time": "1791936000000",
"updated_time": "1791936060000"
}
}
],
"scroll_id": "0",
"has_more": false
}
}创建视频或图文生成任务
- 请求方法: POST
- 请求路径:
/geo/video/create
说明:任务异步执行,通过查询视频或图文任务状态及结果读取结果。同一品牌的同一文章已有进行中的任务时,会返回任务进行中的错误。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
article_id | string | 文章 ID。 | 是 |
generation_mode | string | 默认 ocr_text;可用 text_to_video、slide_to_video、image_to_video、html_to_video、ocr_text、ocr_image。ocr_image 生成图片,其余生成视频。 | 否 |
aspect_ratio | string | 16:9、9:16 或 1:1;默认 16:9。 | 否 |
narration_mode | string | ai 或 custom;默认 ai。 | 否 |
custom_narration | string | narration_mode=custom 时必填;英文 30–800 词,其他当前按 100–5000 字符校验。 | 条件必填 |
请求示例:
{
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937",
"generation_mode": "ocr_image",
"aspect_ratio": "9:16",
"narration_mode": "ai"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
video_id | string | 顶层任务 ID(UUID),不在 data 内。 |
响应示例:
{
"code": 0,
"msg": "success",
"video_id": "550e8400-e29b-41d4-a716-446655440000"
}查询视频或图文任务状态及结果
- 请求方法: POST
- 请求路径:
/geo/video/status
说明:视频结果读取 video_url,ocr_image 图文结果读取 image_urls,失败原因读取 error_msg。结果地址为临时地址,请使用最新查询返回的地址。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
video_id | string | 视频或图文生成任务 ID(UUID)。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"video_id": "550e8400-e29b-41d4-a716-446655440000"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data | object | 任务状态及结果。 |
data.video_id | string | 生成任务 ID(UUID)。 |
data.article_id | string | 文章 ID。 |
data.brand_id | string | 品牌 ID。 |
data.status | string | pending、processing、completed、failed。 |
data.title | string | 生成结果标题。 |
data.video_url | string | 视频结果的临时访问 URL;未完成或纯图文任务可为空。 |
data.image_urls | string 数组 | ocr_image 生成的图片访问 URL。 |
data.generation_mode | string | 生成模式。 |
data.duration | number | 视频时长(秒);图文任务可为 0。 |
data.created_at | string | 创建时间,格式 YYYY-MM-DD HH:mm:ss。 |
data.error_msg | string | 失败原因;非失败状态可为空。 |
data.creator_name | string | 创建人显示名;历史数据可为空。 |
data.description | string | 生成结果描述。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"video_id": "550e8400-e29b-41d4-a716-446655440000",
"article_id": "2072208110612647937",
"brand_id": "2072208110612647936",
"status": "completed",
"title": "测试文章A",
"video_url": "",
"image_urls": [
"https://example.com/generated/guide-1.png"
],
"generation_mode": "ocr_image",
"duration": 0,
"created_at": "2026-10-14 10:00:00",
"error_msg": "",
"creator_name": "测试用户A",
"description": "测试产品A介绍"
}
}查询文章的视频与图文任务列表
- 请求方法: POST
- 请求路径:
/geo/video/list
说明:返回 brand_id 指定品牌下该文章的生成任务;该接口不分页。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
article_id | string | 文章 ID。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"article_id": "2072208110612647937"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
total | int | 顶层任务数量。 |
list | object 数组 | 顶层任务列表,不在 data 内。 |
list[].video_id | string | 生成任务 ID(UUID)。 |
list[].article_id | string | 文章 ID。 |
list[].brand_id | string | 品牌 ID。 |
list[].status | string | pending、processing、completed、failed。 |
list[].title | string | 生成结果标题。 |
list[].video_url | string | 视频结果的临时访问 URL;未完成或纯图文任务可为空。 |
list[].image_urls | string 数组 | ocr_image 生成的图片访问 URL。 |
list[].generation_mode | string | 生成模式。 |
list[].duration | number | 视频时长(秒);图文任务可为 0。 |
list[].created_at | string | 创建时间,格式 YYYY-MM-DD HH:mm:ss。 |
list[].error_msg | string | 失败原因;非失败状态可为空。 |
list[].creator_name | string | 创建人显示名;历史数据可为空。 |
list[].description | string | 生成结果描述。 |
响应示例:
{
"code": 0,
"msg": "success",
"total": 1,
"list": [
{
"video_id": "550e8400-e29b-41d4-a716-446655440000",
"article_id": "2072208110612647937",
"brand_id": "2072208110612647936",
"status": "completed",
"title": "测试文章A",
"video_url": "",
"image_urls": [
"https://example.com/generated/guide-1.png"
],
"generation_mode": "ocr_image",
"duration": 0,
"created_at": "2026-10-14 10:00:00",
"error_msg": "",
"creator_name": "测试用户A",
"description": "测试产品A介绍"
}
]
}删除视频或图文任务
- 请求方法: POST
- 请求路径:
/geo/video/delete
说明:该操作删除任务记录,不用于取消正在执行的生成任务。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
video_id | string | 视频或图文生成任务 ID(UUID)。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"video_id": "550e8400-e29b-41d4-a716-446655440000"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
响应示例:
{
"code": 0,
"msg": "success"
}下载已完成图文任务的图片包
- 请求方法: POST
- 请求路径:
/geo/video/image-text/download-pack
说明:仅支持 generation_mode=ocr_image 且 status=completed 的任务。
请求参数:
| 入参 | 类型 | 含义 | 是否必填 |
|---|---|---|---|
brand_id | string | 品牌 ID。64 位整数用十进制字符串传递。 | 是 |
video_id | string | 视频或图文生成任务 ID(UUID)。 | 是 |
请求示例:
{
"brand_id": "2072208110612647936",
"video_id": "550e8400-e29b-41d4-a716-446655440000"
}响应参数:
| 返回值 | 类型 | 含义 |
|---|---|---|
code | int | 业务状态码;0 表示成功。 |
msg | string | 状态说明。 |
data.download_url | string | ZIP 包预签名 URL,有效期 5 分钟。 |
data.file_name | string | 建议下载文件名。 |
data.image_count | int | 图片数量。 |
响应示例:
{
"code": 0,
"msg": "success",
"data": {
"download_url": "https://example.com/generated/550e8400-e29b-41d4-a716-446655440000.zip?signature=EXAMPLE",
"file_name": "test-article-a.zip",
"image_count": 1
}
}