Download OpenAPI specification:Download
three_stage
: 使用带有标题、描述和按钮的样式。anchor_text
: 使用锚文本样式。此参数仅在启用 isAddCta
时有效。isAddKeyTakeaways
: 默认启用isAddCta
: 默认禁用isAddFaq
: 默认启用isAddKeyTakeaways
、isAddCta
、ctaModelType
和 isAddFaq
。X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
accessKey required | string 用于授权的访问密钥 |
secretKey required | string 用于授权的秘密密钥 |
tokenExpiry | integer [ 7 .. 90 ] Default: 7 令牌的过期时间(单位:天,默认值为 7,最大值为 90) |
{- "accessKey": "string",
- "secretKey": "string",
- "tokenExpiry": 7
}
{- "message": "成功",
- "data": {
- "token": ""
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
name required | string |
language | string Default: "en" Enum: {"en":"英语"} {"zh-CN":"简体中文"} {"zh-TW":"繁体中文"} {"de":"德语"} {"es":"西班牙语"} {"fr":"法语"} {"it":"意大利语"} {"pt-PT":"葡萄牙语(葡萄牙)"} {"pt-BR":"葡萄牙语(巴西)"} {"nl":"荷兰语"} {"pl":"波兰语"} {"vi":"越南语"} {"hi":"印地语"} {"id":"印度尼西亚语"} {"ar":"阿拉伯语"} {"ru":"俄语"} {"ja":"日语"} {"tr":"土耳其语"} {"th":"泰语"} {"el":"希腊语"} {"da":"丹麦语"} {"cs":"捷克语"} {"bg":"保加利亚语"} {"ko":"韩语"} {"hu":"匈牙利语"} {"lt":"立陶宛语"} {"ms":"马来语"} {"no":"挪威语"} {"ro":"罗马尼亚语"} {"sv":"瑞典语"} {"bo":"藏语"} 语言 ID(默认值为 "en") |
{- "name": "BLOG",
- "language": {
- "en": "英语"
}
}
{- "message": "站点创建成功",
- "data": {
- "site_id": "",
- "name": ""
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
type | string Example: type=BLOG 按类型过滤站点(LANDING_PAGE 或 BLOG) |
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": [
- {
- "site_id": "",
- "name": "",
- "type": "",
- "knowledge_store_id": ""
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
siteId required | string 要更新的站点 ID |
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
name required | string 重命名站点名称 |
{- "name": "string"
}
{- "message": "成功",
- "data": {
- "site_id": "",
- "name": ""
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": [
- {
- "description": "",
- "id": "",
- "name": " "
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
检索关于 WordPress 的信息
siteId required | string QuickCreator 站点 ID |
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": {
- "qc_id": "",
- "users": [
- {
- "id": "",
- "name": ""
}
], - "categories": [
- {
- "id": "",
- "name": ""
}
], - "post_types": [
- {
- "label": "",
- "value": ""
}
]
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
检索关于知识的相关信息
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": [
- {
- "store_id": "",
- "brand_id": "",
- "brand_name": ""
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
siteId required | string or null 站点的 ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isPublish required | boolean or null Default: true 指示是否发布博客 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
authorId | string or null Default: null 作者的 ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inputType required | string Enum: "keyword" "topic" "url" "urls" "title" 输入的类型。必须是关键字、主题、URL、URLs、标题之一。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mainInput | string or null 主要输入内容与不同的写作条目类型(
这些输入���项确保用户可以根据需求灵活选择写作方式。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
primaryKeyword | Array of strings = 1 items
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
languageID | string Default: "en"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
locale | string Default: "us" 此参数设置博客的目标市场。
写作引擎将根据所选目标语言和国家/地区实时搜索相关主题和参考资料,以支持博客写作。
如果未选择国家,写作引擎将选择与
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetBlogWordCount | string Enum: "800-1000" "1000-2000" "2000-3000" 此参数设置博客的目标字数范围。 写作引擎将根据此范围控制段落的数量。 请注意,一些博客类型将不受此字数范围的限制,包括但不限于: '指南'、'步骤'、'提示'、'策略'、'分析'、'科学'、'趋势'、'评论'、'列表'、 '替代'、'比较'、'推荐'、'排名'、'优缺点'和 '评分'。 如果未指定目标字数范围,写作引擎将根据博客主题自动选择合适的字数范围。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetTone | string Enum: "Conversational/Informal" "Inspirational/Motivational" "Persuasive" "Entertaining" "Informative/Educational" "Professional/Formal"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetReadability | string Enum: "general" "knowledgeable" "expert"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetPersonPerspective | string Enum: "first-person" "second-person" "third-person"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddKeywordFrequency | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddEvidence | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalTitlePrompt | string [ 1 .. 3000 ] items
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalOutlinePrompt | string non-empty <= 3000
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalSectionPrompt | string non-empty <= 3000
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additionalKnowledge | string [ 0 .. 50000 ] items
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isStartExternalHyperlink | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isStartInternalHyperlink | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
internalHyperlinkDomain | string
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddMainImage | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddH2Images | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddH2Video | boolean
"<!-- qc:embed/youtube {"src": "https://www.youtube.com/watch?v=xxxxxxxxxxx"} -->" 默认情况下,此参数禁用。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddSeeAlso | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isFoundPlaceholderError | boolean
提示: 什么是占位符问题? 占位符问题发生在生成的大纲因收集的数据不足或用户提供的数据不足而不完整时。这在列表类型的文章中尤为明显,其中可能出现占位符符号,如“工具 A”或“工具 B”,这会对文章的最终质量产生负面影响。 如果检测到占位符问题,系统将返回 549 错误代码。默认情况下,此参数启用。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isFilterSimilarTitle | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddKeyTakeaways | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddCta | boolean
默认情况下,此参数禁用。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ctaModelType | string Enum: "three_stage" "anchor_text"
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isAddFaq | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
imageFrom | string Enum: "img_library" "kb" • imageFrom: "img_library" 图像来自公共版权免费库,目前支持 Unsplash 和 Pexel。 • imageFrom: "kb" 图像来自知识库中收集的图像。 注意: image_from 参数仅在启用 knowledgeBaseInfo 时可以设置为 "kb"。 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRaiseEvidenceNotFindError | boolean
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetEvidenceSearchLanguageId | string
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
targetEvidenceLocale | string
|
{- "siteId": "string",
- "isPublish": true,
- "authorId": null,
- "wpInfo": {
- "qc_id": "",
- "category_id": "",
- "auth_id": "",
- "post_type": ""
}, - "webhook": {
- "url": "string",
- "header": {
- "Authorization": "Bearer xxxxxxxxxx"
}
}, - "inputType": "keyword",
- "mainInput": "string",
- "primaryKeyword": [
- "什么是 SEO"
], - "languageID": "en",
- "locale": "us",
- "targetBlogWordCount": "800-1000",
- "targetTone": "Professional/Formal",
- "targetReadability": "expert",
- "targetPersonPerspective": "third-person",
- "isAddKeywordFrequency": true,
- "isAddEvidence": true,
- "additionalTitlePrompt": "标题应为问题并以“什么”开头",
- "additionalOutlinePrompt": "每个 H2 标题都需要是一个问题。",
- "additionalSectionPrompt": "在介绍 SEO 时不要介绍任何公司",
- "additionalManualLinks": [
], - "additionalKnowledge": "string",
- "knowledgeBaseInfo": {
- "store_id": 0,
- "brand_id": 0,
- "brand_name": "string"
}, - "isStartExternalHyperlink": true,
- "isStartInternalHyperlink": true,
- "isAddMainImage": true,
- "isAddH2Images": true,
- "isAddH2Video": true,
- "isAddSeeAlso": true,
- "isFoundPlaceholderError": true,
- "isFilterSimilarTitle": true,
- "isAddKeyTakeaways": true,
- "isAddCta": true,
- "ctaModelType": "three_stage",
- "isAddFaq": true,
- "imageFrom": "img_library",
- "isRaiseEvidenceNotFindError": true,
- "targetEvidenceSearchLanguageId": "string",
- "targetEvidenceLocale": "string"
}
{- "message": "成功",
- "data": {
- "blogId": "",
- "jobId": ""
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
blogId required | string 写作博客 ID |
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": {
- "content": {
- "markdown": "",
- "seo": {
- "description": null,
- "feature_image": null,
- "keywords": null,
- "title": null
}, - "slug": null,
- "title": null
}, - "error": {
- "code": null,
- "message": null
}, - "status": "成功"
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}
获取当前用户的配额
product required | string Example: product=QUICK_BLOG 按产品过滤配额(QUICK_BLOG 或 QUICK_PAGE) |
X-OPENAPI-TOKEN required | string 授权令牌 |
X-Request-ID | string 用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。 |
{- "message": "成功",
- "data": {
- "endDate": "",
- "product": "",
- "resource": [
- {
- "name": "",
- "quota": "",
- "used": ""
}
], - "knowledge": ""
}, - "timestamp": "2019-08-24T14:15:22Z",
- "request_id": "string"
}