QuickCreator OpenAPI (v1)

Download OpenAPI specification:Download

v1

QuickCreator OpenAPI 版本 1

更新日志

2025-01-10

新特性

  • isRaiseEvidenceNotFindError
    • 确定在搜索过程中如果未找到证据是否应该报告错误。默认情况下,此参数是启用的。
  • targetEvidenceSearchLanguageId
    • 指定在搜索证据时使用的语言,解决在不常见的默认语言中证据不足的问题。如果未提供,默认为文章的写作语言。
  • targetEvidenceLocale
    • 指定在搜索证据时考虑的国家/地区。此参数解决在不常见的默认地区中证据不足的问题。如果未提供,默认为与文章写作相关的国家/地区。

2024-12-04

新特性

  • isAddKeyTakeaways
    • 添加参数以在介绍后生成“关键要点”部分,帮助读者快速掌握文章的核心内容。默认启用。
  • isAddCta
    • 仅在输入类型为 URL 时有效的参数。当启用时,它会在博客页面中插入一个行动号召(CTA)部分,旨在提高用户转化率和体验。默认禁用。
  • ctaModelType
    • 添加参数以指定 CTA 模块的显示类型。可能的值包括:
      • three_stage: 使用带有标题、描述和按钮的样式。
      • anchor_text: 使用锚文本样式。此参数仅在启用 isAddCta 时有效。
  • isAddFaq
    • 添加参数以在博客末尾包含常见问题(FAQ)部分,旨在改善用户体验,减少客户支持工作量,并优化 SEO。默认启用。

默认值

  • isAddKeyTakeaways: 默认启用
  • isAddCta: 默认禁用
  • isAddFaq: 默认启用

受影响的端点

  • POST /v1/writing/blog: 在创建新博客时可以使用参数 isAddKeyTakeawaysisAddCtactaModelTypeisAddFaq

获取令牌

header Parameters
X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Request Body schema: application/json
required
accessKey
required
string

用于授权的访问密钥

secretKey
required
string

用于授权的秘密密钥

tokenExpiry
integer [ 7 .. 90 ]
Default: 7

令牌的过期时间(单位:天,默认值为 7,最大值为 90)

Responses

Request samples

Content type
application/json
{
  • "accessKey": "string",
  • "secretKey": "string",
  • "tokenExpiry": 7
}

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

创建新站点

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Request Body schema: application/json
required
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")

Responses

Request samples

Content type
application/json
{
  • "name": "BLOG",
  • "language": {
    }
}

Response samples

Content type
application/json
{
  • "message": "站点创建成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

检索所有站点

query Parameters
type
string
Example: type=BLOG

按类型过滤站点(LANDING_PAGE 或 BLOG)

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

更新站点名称

query Parameters
siteId
required
string

要更新的站点 ID

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Request Body schema: application/json
required
name
required
string

重命名站点名称

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

获取用户的作者信息

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

获取 WordPress 信息

检索关于 WordPress 的信息

query Parameters
siteId
required
string

QuickCreator 站点 ID

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

获取知识信息

检索关于知识的相关信息

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

撰写博客

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Request Body schema: application/json
required
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

主要输入内容与不同的写作条目类型(input_type)相关:

  1. input_type 为 'keyword' 时:用户应输入一个主要关键字,建议不超过三个英文单词(用于英文写作),以逐步撰写博客。输入必须是最大长度为 100 个字符的字符串。
  2. input_type 为 'topic' 时:用户可以输入任何特定主题或想法,写作引擎将围绕该主题写一篇博客。输入必须是最大长度为 150 个字符的字符串。
  3. input_type 为 'url' 时:用户应输入一个产品的 URL,写作引擎将围绕该产品进行写作。输入必须是有效的 URL 字符串。输入必须是字符串数组,每个都是有效的 URL。
  4. input_type 为 'urls' 时:用户可以输入最多五个文章 URL,系统将忽略非文章链接。输入必须是字符串数组,每个都是有效的 URL,最大长度为 5 个项目。
  5. input_type 为 'title' 时:用户可以输入任何博客标题,写作引擎将围绕该标题生成博客内容。输入必须是最大长度为 150 个字符的字符串。

这些输入���项确保用户可以根据需求灵活选择写作方式。

primaryKeyword
Array of strings = 1 items
  • 用户可以在博客写作过程中指定主要关键字。
  • 写作引擎将把主要关键字纳入博客标题、副标题标题、博客内容和页面的元信息,同时合理分配关键字密度。
  • 当前仅支持一个主要关键字,对于英文写作,建议主要关键字不超过三个英文单词。
  • 请注意,当输入类型为 "Keyword" 时,primaryKeywords 将无效。
languageID
string
Default: "en"
  • 此参数设置博客写作的语言和博客的目标市场。
  • 写作引擎将根据所选目标语言和国家/地区实时搜索相关主题和参考资料,以支持博客写作。
  • 限制为枚举中提供的语言。
    语言 代码
    阿拉伯语 ar
    保加利亚语 bg
    孟加拉语 bn
    捷克语 cs
    丹麦语 da
    荷兰语 nl
    英语 en
    爱沙尼亚语 et
    希腊语 el
    芬兰语 fi
    法语 fr
    德语 de
    匈牙利语 hu
    印度尼西亚语 id
    意大利语 it
    日语 ja
    韩语 ko
    立陶宛语 lt
    马来语 ms
    挪威语 no
    波兰语 pl
    巴西葡萄牙语 pt-BR
    葡萄牙语 pt
    罗马尼亚语 ro
    西班牙语 es
    俄语 ru
    泰语 th
    土耳其语 tr
    越南语 vi
    简体中文 zh-CN
    繁体中文 zh-TW
locale
string
Default: "us"

此参数设置博客的目标市场。 写作引擎将根据所选目标语言和国家/地区实时搜索相关主题和参考资料,以支持博客写作。 如果未选择国家,写作引擎将选择与 languageID 中设置的目标语言匹配的默认国家/地区。 默认值: "us"

国家 代码
阿根廷 ar
阿鲁巴 aw
澳大利亚 au
奥地利 at
阿塞拜疆 az
巴哈马 bs
孟加拉国 bd
比利时 be
巴西 br
保加利亚 bg
喀麦隆 cm
加拿大 ca
智利 cl
中国 cn
哥伦比亚 co
哥斯达黎加 cr
克罗地亚 hr
古巴 cu
塞浦路斯 cy
捷克共和国 cz
丹麦 dk
埃及 eg
爱沙尼亚 ee
埃塞俄比亚 et
芬兰 fi
法国 fr
德国 de
加纳 gh
希腊 gr
格林纳达 gl
香港 hk
匈牙利 hu
冰岛 is
印度 in
印尼 id
爱尔兰 ie
以色列 il
意大利 it
牙买加 jm
日本 jp
哈萨克斯坦 kz
韩国 kr
拉脱维亚 lv
利比亚 ly
立陶宛 lt
卢森堡 lu
澳门 mo
前南斯拉夫 mk
马来西亚 my
马耳他 mt
墨西哥 mx
摩纳哥 mc
荷兰 nl
新西兰 nz
尼日利亚 ng
挪威 no
巴基斯坦 pk
巴拿马 pa
巴拉圭 py
秘鲁 pe
菲律宾 ph
波兰 pl
葡萄牙 pt
波多黎各 pr
卡塔尔 qa
罗马尼亚 ro
俄罗斯联邦 ru
沙特阿拉伯 sa
塞尔维亚 rs
新加坡 sg
斯洛伐克 sk
斯洛文尼亚 si
南非 za
西班牙 es
瑞典 se
瑞士 ch
叙利亚 sy
台湾 tw
泰国 th
突尼斯 tn
土耳其 tr
乌克兰 ua
阿联酋 ae
英国 gb
美国 us
targetBlogWordCount
string
Enum: "800-1000" "1000-2000" "2000-3000"

此参数设置博客的目标字数范围。 写作引擎将根据此范围控制段落的数量。 请注意,一些博客类型将不受此字数范围的限制,包括但不限于: '指南'、'步骤'、'提示'、'策略'、'分析'、'科学'、'趋势'、'评论'、'列表'、 '替代'、'比较'、'推荐'、'排名'、'优缺点'和 '评分'。 如果未指定目标字数范围,写作引擎将根据博客主题自动选择合适的字数范围。

targetTone
string
Enum: "Conversational/Informal" "Inspirational/Motivational" "Persuasive" "Entertaining" "Informative/Educational" "Professional/Formal"

targetTone 参数允许用户指定博客内容的期望语气。 可能的值包括:

  • 信息性/教育性:旨在通过事实和信息向读者传达知识,直接且专注于知识传递。
  • 专业/正式:建立作者在主题上的专业性和可信度,通常更正式,使用行业特定术语。
  • 交谈式/非正式:友好而放松的语气,像作者与读者之间的对话,使复杂主题更易于理解,使用缩写和提问。
  • 说服性:旨在说服读者采取特定行动,使用有力的语言,专注于好处,并包括行动号召。
  • 鼓舞人心/励志:常见于生活方式和励志博客,旨在激励读者,使用积极的语言和成功故事。
  • 娱乐性:适合旅行、食品和其他娱乐博客,使用幽默和生动的描述来吸引和娱乐读者。
targetReadability
string
Enum: "general" "knowledgeable" "expert"

target_readability 参数用于设置博客的目标阅读水平。写作引擎将根据所选可读性水平控制词汇和句子结构。如果未指定目标可读性,写作引擎将根据博客主题自动选择合适的水平。目前支持以下三个级别:

  • 一般(初中,6-8 年级):相对易读,适合广泛受众。
  • 有知识(高中,9-12 年级):语言可访问,适合具有一定背景知识的读者。
  • 专家(大学及以上):更具挑战性,适合专业读者或主题专家。
targetPersonPerspective
string
Enum: "first-person" "second-person" "third-person"

target_person_perspective 参数用于设置博客的目标叙述视角。写作引擎将根据所选视角调整主题焦点。如果未指定目标视角,写作引擎将根据博客主题自动选择合适的视角。目前支持以下三种视角:

  • first-person:从“我”的角度书写,直接与读者分享个人经历和观点。
  • second-person:使用“你”直接与读者对话,建立直接联系并让他们参与叙述或讨论。
  • third-person:从外部视角叙述,使用“他”、“她”或“他们”来指代个人,提供更客观和超然的观点。
isAddKeywordFrequency
boolean

isAddKeywordFrequency 参数启用语义相关的 LSI(潜在语义索引)关键字的自动插入。启用时,写作引擎将分析相关关键字及其在参考文章中的分布,以指导博客内容生成。此功能默认关闭。

isAddEvidence
boolean

isAddEvidence 参数允许在博客写作过程中自动插入数据和事实证据,以增强博客的专业性和可信度,符合 Google 的 EEAT(经验、专业、权威、可信度)要求。当启用此功能时,写作引擎将分析所需的证据类型,并实时搜索相关网站以提取和分析有益的数据和事实证据以支持博客写作。默认情况下,此功能启用。

additionalTitlePrompt
string [ 1 .. 3000 ] items

additionalTitlePrompt 参数允许用户在生成博客 H1 标题时添加额外要求,对输入语言没有限制。例如:

  1. 关键字要求:每个生成的标题必须包含关键字 "seo"。
  2. 年份要求:每个生成的标题必须包含年份 "2024"。
  3. 字数要求:每个生成的标题的长度必须在 12 个单词以内。
  4. 风格要求:确保标题使用引人注目的单词或短语。避免过长或复杂的句子结构,努力清晰简洁地表达主题。
additionalOutlinePrompt
string non-empty <= 3000

additionalOutlinePrompt 参数允许用户在生成博客大纲时添加额外要求,对输入语言没有限制。例如:

  1. 标题数量要求:确保生成 5 到 7 个 H2 级别的标题。
  2. 标题内容要求:确保第一个 H2 级别标题不是“介绍”,最后一个 H2 级别标题不是“结论”。
  3. 关键字要求:确保生成的标题包含关键字 "seo"。
  4. 列表内容要求:确保在列出产品时包含“我的品牌名称”。
additionalSectionPrompt
string non-empty <= 3000

additionalSectionPrompt 参数允许用户在生成博客内容时添加额外要求,对输入语言没有限制。例如:

  1. 产品信息要求:在写作过程中适当使用以下产品信息:我的品牌名称是一个 AI 驱动的营销工具....
  2. 内容真实性要求:在介绍 SEO 时不要生成虚假的信息,例如客户反馈或评论。
Array of objects or null

additionalManualLinks 功能允许用户自定义锚文本及其对应的链接,写作引擎将自然地将其嵌入到博客内容中,优先在第一段中插入指定的锚文本,以增强内容相关性和 SEO 效果。此功能支持最多 5 个锚文本及对应链接。

additionalKnowledge
string [ 0 .. 50000 ] items

additionalKnowledge 功能允许用户补充额外的知识点,以扩展内容的背景和专业性。这些信息帮助写作引擎更好地理解主题,从而生成更丰富、更深入的内容,满足 SEO 和读者需求。用户可以补充品牌和产品知识、行业背景、技术细节、案例研究、市场研究、专家意见和相关术语,以增强博客内容的深度和专业性。

object or null

knowledgeBaseInfo 功能允许写作引擎从用户的知识库中提取品牌和产品相关信息,以增强文章的专业性和可信度。此功能帮助用户更好地展示产品特性和品牌价值,从而增加内容的吸引力和可信度。

isStartExternalHyperlink
boolean

isStartExternalHyperlink 功能允许用户在写作过程中启用外部链接的插入,使得在博客中添加相关的外部资源和参考链接变得更加容易,以增强文章的深度和可信度。此功能有效支持 SEO 优化和信息来源的引用。默认情况下,此功能启用。

isStartInternalHyperlink
boolean

isStartInternalHyperlink 参数允许用户在写作过程中启用内部链接的插入,为文章添加与主题相关的内部链接。这增强了内容的连贯性,改善了用户体验,并有助于 SEO 优化。用户需要在 internal_hyperlink_domain 参数中指定内部链接的源域或站点子路径。写作引擎将使用 Google 的站点搜索来查找并插入相关的内部链接。默认情况下,此功能启用。

internalHyperlinkDomain
string

internalHyperlinkDomain 参数指定在启用内部链接插入功能后,用作内部链接的源域或网站子路径。写作引擎将使用 Google 的站点搜索功能在指定域或子路径中搜索与当前博客主题相关的页面,并自动将找到的内部链接插入到博客内容中。此功能有助于增强文章结构,引导用户浏览更多相关内容,并提高 SEO 效果。

isAddMainImage
boolean

isAddMainImage 参数允许为博客添加封面图像。写作引擎将从版权免费图像库中匹配与主题相关的高质量封面图像,因此用户不必担心版权问题。添加封面图像可以有效吸引读者的注意力,提高博客的视觉吸引力,并在社交媒体分享时提高点击率。此外,适当的封面图像可以帮助传达文章的主题和情感,为整体内容增加专业性。默认情况下,此功能启用。

isAddH2Images
boolean

isAddH2Images 参数允许写作引擎为正文部分匹配 1 到 2 张高质量图像,来源于版权免费图像库,因此用户不必担心版权问题。添加这些图像可以增强可读性,改善用户体验,并提高可分享性,从而改善 SEO 效果,使博客内容更具吸引力和专业性。默认情况下,此功能启用。

isAddH2Video
boolean

isAddH2Video 参数允许写作引擎为正文部分匹配一段高质量的相关 YouTube 视频,用户无需担心版权问题。添加这些视频可以丰富博客内容,提供更深入的见解和示例,增强读者互动性,并改善内容的吸引力和可分享性,同时也有助于提高 SEO 效果,使博客更具教育性和娱乐性。由于标准 Markdown 语法不支持嵌入视频,我们将其表示为注释。 例如:

"<!-- qc:embed/youtube {"src": "https://www.youtube.com/watch?v=xxxxxxxxxxx"} -->"

默认情况下,此参数禁用。

isAddSeeAlso
boolean

isAddSeeAlso 参数允许写作引擎在文章正文末尾添加“另见”模块。此功能有助于改善文章结构,引导用户探索更多相关内容,并增强 SEO 性能。当启用时,写作引擎将从绑定域的站点地图中搜索与博客主题相关的最多 5 篇文章。 请注意,此功能仅在 QuickCreator 成功绑定到域时有效。目前不支持索引站点地图,因此如果绑定的域使用索引站点地图,则无法添加“另见”模块。

isFoundPlaceholderError
boolean

isFoundPlaceholderError 参数启用时,会检查生成的大纲中是否存在占位符问题。

提示: 什么是占位符问题?

占位符问题发生在生成的大纲因收集的数据不足或用户提供的数据不足而不完整时。这在列表类型的文章中尤为明显,其中可能出现占位符符号,如“工具 A”或“工具 B”,这会对文章的最终质量产生负面影响。 如果检测到占位符问题,系统将返回 549 错误代码。默认情况下,此参数启用。

isFilterSimilarTitle
boolean

isFilterSimilarTitle 参数启用时,会检查生成的博客标题是否与之前生成的标题具有高度相似性。此机制旨在防止创建内容相似的文章。 如果检测到高度相似,系统将返回错误代码 544。默认情况下,此参数启用。

isAddKeyTakeaways
boolean

isAddKeyTakeaways 参数启用时,在介绍后生成“关键要点”部分。关键要点代表读者在阅读文章后应保留的主要信息、见解或可操作建议。 它们总结了文章的核心内容,帮助读者快速掌握其要点,并在未来的回顾中轻松回忆起关键点。默认情况下,此参数启用。

isAddCta
boolean

isAddCta 参数仅在输入类型设置为 URL 时有效。当启用时,isAddCta 参数会在博客页面中插入一个行动号召(CTA)部分。CTA 的目的是引导用户采取特定行动,增强网站的转化率和用户体验。 CTA 将以注释格式表示如下:

  1. 当 ctaModelType == "three_stage" 时:

    "<!-- qc:embed/CTA {"model_type": "three_stage", "link": "https://xxxxx\", "title": "xxx", "description": "xxx", "button_text": "xxx"} -->"

  2. 当 ctaModelType == "anchor_text" 时:

    "<!-- qc:embed/CTA {"model_type": "anchor_text", "link": "https://xxx\", "content": "xxxx xxxx xxxx"} -->"

默认情况下,此参数禁用。

ctaModelType
string
Enum: "three_stage" "anchor_text"

ctaModelType 参数仅在启用 isAddCta 参数时有效。它指定 CTA 模块的显示类型:

  1. "three_stage": 使用带有标题、描述和按钮的样式。
  2. "anchor_text": 使用锚文本样式。
isAddFaq
boolean

isAddFaq 参数启用时,在博客末尾添加常见问题(FAQ)部分。FAQ 部分作为一个功能模块,旨在改善用户体验,减少客户支持工作量,优化 SEO,并通过回答常见问题建立信任。 默认情况下,此参数启用。

imageFrom
string
Enum: "img_library" "kb"

• imageFrom: "img_library"

图像来自公共版权免费库,目前支持 Unsplash 和 Pexel。

• imageFrom: "kb"

图像来自知识库中收集的图像。

注意: image_from 参数仅在启用 knowledgeBaseInfo 时可以设置为 "kb"。

isRaiseEvidenceNotFindError
boolean

is_raise_evidence_not_find_error 确定如果在搜索过程中未找到证据是否应该报告错误。 默认情况下,此参数启用。

targetEvidenceSearchLanguageId
string

target_evidence_search_language_id 指定在搜索证据时使用的语言。 这解决了在不常见的默认语言中证据不足的问题。 如果未提供,则默认为文章的写作语言。

语言 代码
阿拉伯语 ar
保加利亚语 bg
孟加拉语 bn
捷克语 cs
丹麦语 da
荷兰语 nl
英语 en
爱沙尼亚语 et
希腊语 el
芬兰语 fi
法语 fr
德语 de
匈牙利语 hu
印度尼西亚语 id
意大利语 it
日语 ja
韩语 ko
立陶宛语 lt
马来语 ms
挪威语 no
波兰语 pl
巴西葡萄牙语 pt-BR
葡萄牙语 pt
罗马尼亚语 ro
西班牙语 es
俄语 ru
泰语 th
土耳其语 tr
越南语 vi
简体中文 zh-CN
繁体中文 zh-TW
targetEvidenceLocale
string

target_evidence_locale 指定在搜索证据时考虑的国家/地区。 这解决了在不常见的默认地区中证据不足的问题。 如果未提供,则默认为与文章写作相关的国家/地区。

国家 代码
阿根廷 ar
阿鲁巴 aw
澳大利亚 au
奥地利 at
阿塞拜疆 az
巴哈马 bs
孟加拉国 bd
比利时 be
巴西 br
保加利亚 bg
喀麦隆 cm
加拿大 ca
智利 cl
中国 cn
哥伦比亚 co
哥斯达黎加 cr
克罗地亚 hr
古巴 cu
塞浦路斯 cy
捷克共和国 cz
丹麦 dk
埃及 eg
爱沙尼亚 ee
埃塞俄比亚 et
芬兰 fi
法国 fr
德国 de
加纳 gh
希腊 gr
格林纳达 gl
香港 hk
匈牙利 hu
冰岛 is
印度 in
印尼 id
爱尔兰 ie
以色列 il
意大利 it
牙买加 jm
日本 jp
哈萨克斯坦 kz
韩国 kr
拉脱维亚 lv
利比亚 ly
立陶宛 lt
卢森堡 lu
澳门 mo
前南斯拉夫 mk
马来西亚 my
马耳他 mt
墨西哥 mx
摩纳哥 mc
荷兰 nl
新西兰 nz
尼日利亚 ng
挪威 no
巴基斯坦 pk
巴拿马 pa
巴拉圭 py
秘鲁 pe
菲律宾 ph
波兰 pl
葡萄牙 pt
波多黎各 pr
卡塔尔 qa
罗马尼亚 ro
俄罗斯联邦 ru
沙特阿拉伯 sa
塞尔维亚 rs
新加坡 sg
斯洛伐克 sk
斯洛文尼亚 si
南非 za
西班牙 es
瑞典 se
瑞士 ch
叙利亚 sy
台湾 tw
泰国 th
突尼斯 tn
土耳其 tr
乌克兰 ua
阿联酋 ae
英国 gb
美国 us

Responses

Request samples

Content type
application/json
{
  • "siteId": "string",
  • "isPublish": true,
  • "authorId": null,
  • "wpInfo": {
    },
  • "webhook": {
    },
  • "inputType": "keyword",
  • "mainInput": "string",
  • "primaryKeyword": [
    ],
  • "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": {
    },
  • "isStartExternalHyperlink": true,
  • "isStartInternalHyperlink": true,
  • "internalHyperlinkDomain": "https://quickcreator.io",
  • "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"
}

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

获取博客结果

query Parameters
blogId
required
string

写作博客 ID

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}

获取配额

获取当前用户的配额

query Parameters
product
required
string
Example: product=QUICK_BLOG

按产品过滤配额(QUICK_BLOG 或 QUICK_PAGE)

header Parameters
X-OPENAPI-TOKEN
required
string

授权令牌

X-Request-ID
string

用于跟踪请求的唯一请求 ID。 如果未提供,系统将自动生成一个随机请求 ID。

Responses

Response samples

Content type
application/json
{
  • "message": "成功",
  • "data": {
    },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "request_id": "string"
}