API 参考
查阅 Sukidata API 的端点、参数和响应结构,涵盖 Google 搜索、Twitter 时间线、图片生成与编辑、JEV 结构化判断以及结果查询。
通用
获取 OpenAPI 文档
GET/openapi.json
响应
200OpenAPI 3.1 JSON 文档。
application/json
object
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
Web Data
创建 SERP 搜索
POST/v1/serp
请求体 · 必填
application/json
Google SERP 请求参数。字符串字段会去除首尾空白;除非字段另有更小限制,最大为 4096 个 UTF-8 字节。
engine可选stringenum
["google"]default
"google"约束
maxLength4096
q必填stringGoogle 搜索查询词,支持 site:、inurl:、intitle: 等高级运算符。
约束
minLength1maxLength4096pattern"\\S"
as_dt可选string | null与 as_sitesearch 配合使用,用于包含或排除网站的 Google 高级搜索参数。
约束
maxLength4096
as_epq可选string | nullGoogle 高级搜索中的精确短语查询。
约束
maxLength4096
as_eq可选string | nullGoogle 高级搜索中要排除的查询词。
约束
maxLength4096
as_lq可选string | nullGoogle 高级搜索中的链接页面查询 URL。
约束
maxLength4096
as_nlo可选string | nullGoogle 高级搜索数值范围的下限。
约束
maxLength4096
as_nhi可选string | nullGoogle 高级搜索数值范围的上限。
约束
maxLength4096
as_oq可选string | nullGoogle 高级搜索中的可选查询词。
约束
maxLength4096
as_q可选string | nullGoogle 高级搜索中的附加查询词。
约束
maxLength4096
as_qdr可选string | nullGoogle 高级搜索的快捷日期范围,例如 d10、w2、m1 或 y。
约束
maxLength4096
as_rq可选string | nullGoogle 高级搜索中的相关页面查询 URL。
约束
maxLength4096
as_sitesearch可选string | nullGoogle 高级搜索中要限制或排除的网站。
约束
maxLength4096
location可选string | nullGET /v1/serp/locations 返回的 Google 搜索位置名称或 ID;不能与 uule 同时使用。
约束
maxLength4096
google_domain可选string不含协议和路径的 Google 搜索域名,例如 google.com、google.de、google.co.jp 或 google.com.br。输入不区分大小写,会转为小写并按支持列表校验。
default
"google.com"约束
maxLength4096pattern"^[Gg][Oo][Oo][Gg][Ll][Ee](?:\\.[Cc][Oo][Mm]|\\.[A-Za-z]{2}|\\.(?:[Cc][Oo][Mm]|[Cc][Oo])\\.[A-Za-z]{2})$"
gl可选string两位 Google 国家或地区代码。输入不区分大小写,会转为小写并按支持列表校验。
default
"us"约束
minLength2maxLength2pattern"^[A-Za-z]{2}$"
hl可选stringGoogle 界面语言代码,例如 en、ja、pt-br 或 zh-cn。输入会转为小写并按支持列表校验。
default
"en"约束
minLength2maxLength32pattern"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
uule可选string | nullGoogle 编码位置;不能与 location 同时使用。
约束
maxLength4096
lat可选用于 Google GPS 定位的纬度。必须与 lon 同时使用,且不能与 location 或 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum-90maximum90
string约束
pattern"^-?(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nulllon可选用于 Google GPS 定位的经度。必须与 lat 同时使用,且不能与 location 或 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum-180maximum180
string约束
pattern"^-?(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nullradius可选位置或 GPS 定位的搜索半径。桌面设备最大为 199,平板或移动设备最大为 1000;不能与 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum1
string约束
pattern"^(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nullludocid可选string | null地点结果的 Google CID。
约束
maxLength4096
lsig可选string | null部分本地结果和知识图谱视图使用的 Google lsig 值。
约束
maxLength4096
kgmid可选string | nullGoogle 知识图谱实体 ID。
约束
maxLength4096
si可选string | nullGoogle 加密或缓存搜索参数令牌。
约束
maxLength4096
ibp可选string | nullGoogle 布局或展开参数。
约束
maxLength4096
uds可选string | nullSERP 筛选链接返回的 Google 筛选令牌。
约束
maxLength4096
cr可选string | nullGoogle 国家或地区限制筛选器。使用一个或多个以
|分隔的 countryXX 令牌,例如countryUS|countryJP。约束
maxLength4096
lr可选string | nullGoogle 语言限制筛选器。使用一个或多个以
|分隔的 lang_xx 令牌,例如lang_en|lang_zh-CN。约束
maxLength4096
tbs可选string | null约束
maxLength4096
tbm可选string | null支持的 Google 搜索类型;普通 Google 搜索请省略该参数。
enum
["isch","lcl","vid","nws","shop","pts",null]约束
maxLength4096
safe可选stringenum
["off","active"]default
"off"约束
maxLength4096
nfpr可选booleandefault
falsefilter可选booleandefault
truestart可选integerdefault
0约束
minimum0
device可选stringenum
["desktop","tablet","mobile"]default
"desktop"约束
maxLength4096
async可选boolean为 false 时,API 等待搜索结果,也可能返回可轮询的处理中响应;为 true 时,API 立即返回可轮询的搜索响应。
default
falseno_cache可选booleandefault
falsewebhook可选
约束
required["q"]
additionalProperties
false
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200搜索状态、完成结果或失败结果。
application/json
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填search_information必填organic_results可选arrayads可选array数组元素
answer_box可选ai_overview可选knowledge_graph可选local_results可选top_stories可选array数组元素
images_results可选array数组元素
videos_results可选array数组元素
shopping_results可选arrayrelated_questions可选related_searches可选arraypagination可选
约束
required["search_metadata","search_parameters","search_information"]
additionalProperties
true
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Cache-Hitheader · 可选该请求是否符合零积分缓存响应条件。
booleanX-Sukidata-Credits-Usedheader · 可选搜索达到
Success或Error状态后扣除的积分。进行中不返回,缓存响应为0。integerint64
400请求参数无效。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
402积分不足,未创建搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
413请求体过大。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
415请求的 Content-Type 必须为 application/json。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
Webhook · serpWebhook
可选的 SERP Webhook 通知。
POST{$request.body#/webhook/url}
当请求提供 webhook.url 并订阅匹配事件时发送;发送失败时可能重试。
请求体 · 必填
application/json
id必填stringWebhook 通知或事件 ID,与
X-Sukidata-Delivery一致。object必填stringconst
"event"type必填stringenum
["serp.search.queued","serp.search.processing","serp.search.completed","serp.search.failed"]api_version必填stringconst
"v1"created_at必填stringdate-timedata必填
约束
required["id","object","type","api_version","created_at","data"]
additionalProperties
false
请求头
X-Sukidata-Eventheader · 必填stringenum
["serp.search.queued","serp.search.processing","serp.search.completed","serp.search.failed"]X-Sukidata-Deliveryheader · 必填stringX-Sukidata-Timestampheader · 必填stringX-Sukidata-Signatureheader · 可选当 API 密钥配置了 Webhook 密钥时,以
v1=<hex>格式提供 HMAC 签名。string
响应
2XXWebhook 端点已接受通知。
获取 SERP 搜索
GET/v1/serp/{search_id}
请求参数
search_idpath · 必填POST /v1/serp 返回的搜索 ID。格式错误时返回 400;当前 Workspace 无权访问时返回 404。
string约束
maxLength128pattern"^[A-Za-z0-9_-]+$"
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200搜索状态、完成结果或失败结果。
application/json
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填search_information必填organic_results可选arrayads可选array数组元素
answer_box可选ai_overview可选knowledge_graph可选local_results可选top_stories可选array数组元素
images_results可选array数组元素
videos_results可选array数组元素
shopping_results可选arrayrelated_questions可选related_searches可选arraypagination可选
约束
required["search_metadata","search_parameters","search_information"]
additionalProperties
true
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Cache-Hitheader · 可选该请求是否符合零积分缓存响应条件。
booleanX-Sukidata-Credits-Usedheader · 可选搜索达到
Success或Error状态后扣除的积分。进行中不返回,缓存响应为0。integerint64
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
404当前 Workspace 中未找到该搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
获取 Twitter 用户时间线
POST/v1/twitter
获取指定用户的一页公开帖子。后续请求可将 next_cursor 作为 cursor 传入以继续获取。成功请求按实际返回数量计费,每 10 条消耗 1 积分,不足 10 条按 10 条计算,最低 1 积分。
请求体 · 必填
application/json
获取一页 Twitter 用户公开时间线的参数;必须且只能提供一个用户标识。
username可选stringTwitter 用户名,可带或不带前导
@。约束
minLength1maxLength51pattern"^@?[A-Za-z0-9_]+$"
user_id可选string数字格式的 Twitter 用户 ID。
约束
minLength1maxLength32pattern"^[0-9]+$"
max_results可选integer本页最多返回的帖子数量。
default
20约束
minimum1maximum100
cursor可选string上一次请求返回的不透明
next_cursor值。约束
minLength1maxLength8192
async可选boolean为 false 时,API 等待搜索结果,也可能返回可轮询的处理中响应;为 true 时,API 立即返回可轮询的搜索响应。
default
falsewebhook可选
additionalProperties
false
仅满足其中一种 oneOf
约束
required["username"]
条件与其他约束
{
"not": {
"required": [
"user_id"
]
}
}约束
required["user_id"]
条件与其他约束
{
"not": {
"required": [
"username"
]
}
}请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200请求状态、完整时间线结果或失败结果。
application/json
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填user必填tweets必填next_cursor可选string下一页的不透明游标;没有下一页时不返回。
约束
minLength1maxLength8192
约束
required["search_metadata","search_parameters","user","tweets"]
additionalProperties
false
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Cache-Hitheader · 可选该请求是否符合零积分缓存响应条件。
booleanX-Sukidata-Credits-Usedheader · 可选搜索达到
Success或Error状态后扣除的积分。进行中不返回,缓存响应为0。integerint64
400请求参数无效。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
402积分不足,未创建搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
413请求体过大。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
415请求的 Content-Type 必须为 application/json。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
Webhook · twitterWebhook
可选的 Twitter Webhook 通知。
POST{$request.body#/webhook/url}
当请求提供 webhook.url 并订阅匹配事件时发送;发送失败时可能重试。
请求体 · 必填
application/json
id必填stringWebhook 通知或事件 ID,与
X-Sukidata-Delivery一致。object必填stringconst
"event"type必填stringenum
["twitter.search.queued","twitter.search.processing","twitter.search.completed","twitter.search.failed"]api_version必填stringconst
"v1"created_at必填stringdate-timedata必填
约束
required["id","object","type","api_version","created_at","data"]
additionalProperties
false
请求头
X-Sukidata-Eventheader · 必填stringenum
["twitter.search.queued","twitter.search.processing","twitter.search.completed","twitter.search.failed"]X-Sukidata-Deliveryheader · 必填stringX-Sukidata-Timestampheader · 必填stringX-Sukidata-Signatureheader · 可选当 API 密钥配置了 Webhook 密钥时,以
v1=<hex>格式提供 HMAC 签名。string
响应
2XXWebhook 端点已接受通知。
获取 Twitter 时间线请求
GET/v1/twitter/{search_id}
请求参数
search_idpath · 必填POST /v1/twitter 返回的搜索 ID。格式错误时返回 400;当前 Workspace 无权访问时返回 404。
string约束
maxLength128pattern"^[A-Za-z0-9_-]+$"
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200请求状态、完整时间线结果或失败结果。
application/json
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填user必填tweets必填next_cursor可选string下一页的不透明游标;没有下一页时不返回。
约束
minLength1maxLength8192
约束
required["search_metadata","search_parameters","user","tweets"]
additionalProperties
false
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Cache-Hitheader · 可选该请求是否符合零积分缓存响应条件。
booleanX-Sukidata-Credits-Usedheader · 可选搜索达到
Success或Error状态后扣除的积分。进行中不返回,缓存响应为0。integerint64
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
404当前 Workspace 中未找到该搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
搜索支持的位置
GET/v1/serp/locations
请求参数
qquery · 可选可选。输入位置搜索词;省略时列出支持的 Google 位置。
string约束
maxLength4096
limitquery · 可选最多返回的位置数量,默认为 10。
integerdefault
10约束
minimum1maximum10
响应
200匹配且受支持的 Google 位置。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
400请求参数无效。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
列出支持的 Google 参数
GET/v1/serp/google-support
响应
200支持的 Google 域名、国家或地区代码、界面语言及限制令牌。
application/json
domains必填countries必填languages必填cr_countries必填lr_languages必填
约束
required["domains","countries","languages","cr_countries","lr_languages"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
列出搜索记录
GET/v1/activity
请求参数
limitquery · 可选最多返回的记录数量,默认为 20。
integerdefault
20约束
minimum1maximum100
cursorquery · 可选上一页列表响应返回的不透明游标。
stringqquery · 可选按搜索 ID、请求 ID、搜索词、Twitter 用户名或用户 ID,以及位置搜索。
string约束
maxLength512
endpointquery · 可选按产品名或其
/v1/...路径筛选。stringenum
["serp","/v1/serp","twitter","/v1/twitter"]statusquery · 可选按状态筛选,
cache返回缓存响应。stringenum
["success","running","failed","cache"]api_key_idquery · 可选按 API Key ID 筛选。
string约束
pattern"^[A-Za-z0-9_.-]{1,128}$"
fromquery · 可选created_at的起始时间,包含该时刻。stringdate-time
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200当前 Workspace 的近期请求记录。
application/json
data必填array数组元素
cursor可选string传入下一次请求的游标;当
has_more=false时不返回。has_more必填boolean
约束
required["data","has_more"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
400请求参数无效。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
获取搜索记录
GET/v1/activity/{search_id}
请求参数
search_idpath · 必填string约束
pattern"^[A-Za-z0-9_-]{1,128}$"
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200当前 Workspace 的请求详情。
application/json
search_id必填stringrequest_id可选string联系支持团队时需提供的请求 ID。
api_key_id可选string原始搜索请求使用的 API 密钥 ID。
product必填stringengine必填stringstatus必填stringenum
["Queued","Processing","Success","Error"]cache_hit必填boolean该搜索是否符合零积分缓存响应条件。
credits_used可选integerint64该搜索消耗的积分;在状态变为
Success或Error前不返回。q可选string搜索查询词(如有)。
search_parameters可选object可在其他请求中复用的搜索参数。
additionalPropertiestruelocation_requested可选stringlocation_used可选stringgoogle_url可选stringurierror_code可选string搜索失败时返回的错误代码。
const
"search_failed"error_message可选string搜索失败时返回的错误信息。
const
"Search request failed"json_endpoint可选stringuriJSON 结果文件,搜索达到
Success或Error状态后可用。raw_html_file可选stringuriHTML 结果文件,搜索结束且文件可用时返回。
created_at必填stringdate-timecompleted_at可选stringdate-time
约束
required["search_id","product","engine","status","cache_hit","created_at"]
additionalProperties
false
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
400请求参数无效。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
404当前 Workspace 中未找到该搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
500服务发生意外错误。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
获取结果文件
GET/searches/{file_token}/{search_id}.{format}
返回 search_metadata.json_endpoint 或 search_metadata.raw_html_file 指向的结果文件。文件 URL 无需 API 认证并保留一个月,请勿公开;仅抓取源页面的产品提供 HTML 文件。
请求参数
file_tokenpath · 必填string约束
minLength1maxLength128pattern"^[A-Za-z0-9_-]+$"
search_idpath · 必填string约束
maxLength128pattern"^[A-Za-z0-9_-]+$"
formatpath · 必填stringenum
["json","html"]
响应
200.json 返回 JSON 搜索结果,.html 返回 HTML 快照。
application/json
仅满足其中一种 oneOf
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填search_information必填organic_results可选arrayads可选array数组元素
answer_box可选ai_overview可选knowledge_graph可选local_results可选top_stories可选array数组元素
images_results可选array数组元素
videos_results可选array数组元素
shopping_results可选arrayrelated_questions可选related_searches可选arraypagination可选
约束
required["search_metadata","search_parameters","search_information"]
additionalProperties
true
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
仅满足其中一种 oneOf
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
search_metadata必填search_parameters必填user必填tweets必填next_cursor可选string下一页的不透明游标;没有下一页时不返回。
约束
minLength1maxLength8192
约束
required["search_metadata","search_parameters","user","tweets"]
additionalProperties
false
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
text/html
string
响应头
Cache-Controlheader · 可选结果文件的缓存策略。
string
404当前 Workspace 中未找到该搜索。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
AI
列出可用 AI 模型
GET/v1/models
列出当前 API Key 可用的模型。
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200采用 OpenAI 兼容列表格式的可用模型。
application/json
object必填const
"list"data必填array数组元素
约束
required["object","data"]
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
生成图片
POST/v1/images/generations
根据提示词生成图片,可选用参考图。默认返回 Base64,设置 response_format 为 url 可获取图片链接。
请求体 · 必填
JSON 或 multipart 请求,最大 48 MiB。可选参考图须为 PNG、JPEG 或 WebP,参考图数量上限由所选模型决定。
application/json
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
从 image 和 images 中选择一个字段,两者均支持单张参考图或数组。
image可选images可选
条件与其他约束
{
"not": {
"required": [
"image",
"images"
]
}
}multipart/form-data
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
image可选stringbinaryPNG、JPEG 或 WebP 文件,多张图片使用重复的 image[] 字段。
image[]可选array约束
minItems1maxItems16
数组元素
stringbinary
请求头
Authorization: Bearer $SUKIDATA_API_KEY
Idempotency-Keyheader · 可选重试同一任务时保持此键、参数和文件不变。键的作用域为 Workspace 和操作,同步与异步提交共用;更改输入返回 409,使用新键会创建新任务。上传中断须在任务创建后十分钟内重试;到期后任务失败、不收费,重新提交须使用新键。
string约束
minLength1maxLength128pattern"^[!-~]+$"
响应
200生成的图片。
application/json
created必填integerint64任务创建时间,以秒为单位的 Unix 时间戳。
data必填array约束
minItems1
数组元素
b64_json可选string约束
contentEncoding"base64"
url可选stringuri图片 URL,自发布起可用 31 天,持有链接的人均可查看。
additionalPropertiesfalse仅满足其中一种
oneOf约束
required["b64_json"]
约束
required["url"]
约束
required["created","data"]
同时满足 allOf
输出信息,有数据时返回。多张图片尺寸不同时省略顶层 size,各图片尺寸可在任务详情的 images 数组中查看。
background可选enum
["opaque","transparent"]output_format可选enum
["png","jpeg","webp"]size可选stringquality可选enum
["low","medium","high","xhigh","max"]usage可选
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
提交异步图片生成
POST/v1/images/generations/async
提交图片生成任务,通过 Location 响应头中的地址查询进度与结果。
请求体 · 必填
JSON 或 multipart 请求,最大 48 MiB。可选参考图须为 PNG、JPEG 或 WebP,参考图数量上限由所选模型决定。
application/json
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
从 image 和 images 中选择一个字段,两者均支持单张参考图或数组。
image可选images可选
条件与其他约束
{
"not": {
"required": [
"image",
"images"
]
}
}multipart/form-data
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
image可选stringbinaryPNG、JPEG 或 WebP 文件,多张图片使用重复的 image[] 字段。
image[]可选array约束
minItems1maxItems16
数组元素
stringbinary
请求头
Authorization: Bearer $SUKIDATA_API_KEY
Idempotency-Keyheader · 可选重试同一任务时保持此键、参数和文件不变。键的作用域为 Workspace 和操作,同步与异步提交共用;更改输入返回 409,使用新键会创建新任务。上传中断须在任务创建后十分钟内重试;到期后任务失败、不收费,重新提交须使用新键。
string约束
minLength1maxLength128pattern"^[!-~]+$"
响应
202任务 ID 和当前状态,复用幂等键时返回同一任务。
application/json
id必填stringobject必填const
"image.task"status必填
约束
required["id","object","status"]
响应头
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
stringLocationheader · 可选需鉴权的任务详情及进度查询地址。
stringuri
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
编辑图片
POST/v1/images/edits
使用提示词和参考图编辑图片。通过 multipart/form-data 上传文件,或通过 JSON 提交图片 URL;可选蒙版用于指定编辑区域。
请求体 · 必填
JSON 或 multipart 请求,至少包含一张参考图,请求体最大 48 MiB。输入支持 PNG、JPEG、WebP,参考图数量上限由所选模型决定。
application/json
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
从 image 和 images 中选择一个字段,两者均支持单张参考图或数组。
image可选images可选
条件与其他约束
{
"not": {
"required": [
"image",
"images"
]
}
}mask可选
至少满足其中一种 anyOf
约束
required["image"]
约束
required["images"]
multipart/form-data
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
image可选stringbinaryPNG、JPEG 或 WebP 文件,多张图片使用重复的 image[] 字段。
image[]可选array约束
minItems1maxItems16
数组元素
stringbinary
mask可选stringbinary带 alpha 通道的 PNG 蒙版,尺寸须与第一张参考图一致。透明区域指定编辑位置,蒙版不占用参考图数量名额。
至少满足其中一种 anyOf
约束
required["image"]
约束
required["image[]"]
请求头
Authorization: Bearer $SUKIDATA_API_KEY
Idempotency-Keyheader · 可选重试同一任务时保持此键、参数和文件不变。键的作用域为 Workspace 和操作,同步与异步提交共用;更改输入返回 409,使用新键会创建新任务。上传中断须在任务创建后十分钟内重试;到期后任务失败、不收费,重新提交须使用新键。
string约束
minLength1maxLength128pattern"^[!-~]+$"
响应
200生成的图片。
application/json
created必填integerint64任务创建时间,以秒为单位的 Unix 时间戳。
data必填array约束
minItems1
数组元素
b64_json可选string约束
contentEncoding"base64"
url可选stringuri图片 URL,自发布起可用 31 天,持有链接的人均可查看。
additionalPropertiesfalse仅满足其中一种
oneOf约束
required["b64_json"]
约束
required["url"]
约束
required["created","data"]
同时满足 allOf
输出信息,有数据时返回。多张图片尺寸不同时省略顶层 size,各图片尺寸可在任务详情的 images 数组中查看。
background可选enum
["opaque","transparent"]output_format可选enum
["png","jpeg","webp"]size可选stringquality可选enum
["low","medium","high","xhigh","max"]usage可选
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
提交异步图片编辑
POST/v1/images/edits/async
提交图片编辑任务,参数和输入限制与同步编辑相同。
请求体 · 必填
JSON 或 multipart 请求,至少包含一张参考图,请求体最大 48 MiB。输入支持 PNG、JPEG、WebP,参考图数量上限由所选模型决定。
application/json
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
从 image 和 images 中选择一个字段,两者均支持单张参考图或数组。
image可选images可选
条件与其他约束
{
"not": {
"required": [
"image",
"images"
]
}
}mask可选
至少满足其中一种 anyOf
约束
required["image"]
约束
required["images"]
multipart/form-data
约束
unevaluatedPropertiesfalse
同时满足 allOf
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
image可选stringbinaryPNG、JPEG 或 WebP 文件,多张图片使用重复的 image[] 字段。
image[]可选array约束
minItems1maxItems16
数组元素
stringbinary
mask可选stringbinary带 alpha 通道的 PNG 蒙版,尺寸须与第一张参考图一致。透明区域指定编辑位置,蒙版不占用参考图数量名额。
至少满足其中一种 anyOf
约束
required["image"]
约束
required["image[]"]
请求头
Authorization: Bearer $SUKIDATA_API_KEY
Idempotency-Keyheader · 可选重试同一任务时保持此键、参数和文件不变。键的作用域为 Workspace 和操作,同步与异步提交共用;更改输入返回 409,使用新键会创建新任务。上传中断须在任务创建后十分钟内重试;到期后任务失败、不收费,重新提交须使用新键。
string约束
minLength1maxLength128pattern"^[!-~]+$"
响应
202任务 ID 和当前状态,复用幂等键时返回同一任务。
application/json
id必填stringobject必填const
"image.task"status必填
约束
required["id","object","status"]
响应头
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
stringLocationheader · 可选需鉴权的任务详情及进度查询地址。
stringuri
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
列出图片任务
GET/v1/images/tasks
列出当前 Workspace 的图片任务,包含状态、费用和图片链接。
请求参数
limitquery · 可选最多返回的记录数量,默认为 20。
integerdefault
20约束
minimum1maximum100
cursorquery · 可选上一页列表响应返回的不透明游标。
stringmodelquery · 可选string约束
maxLength128
statusquery · 可选searchquery · 可选按提示词或任务 ID 搜索。
string约束
maxLength256
operationquery · 可选enum
["images.generations","images.edits"]api_key_idquery · 可选按提交请求的密钥 ID 筛选,包括已删除的密钥。省略时包含所有来源及 Playground 请求。
string约束
maxLength128
created_fromquery · 可选创建时间下界(包含),使用带时区的 RFC 3339 时间戳。
stringdate-timecreated_toquery · 可选创建时间上界(不包含),使用带时区的 RFC 3339 时间戳,必须晚于 created_from。
stringdate-time
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200按创建时间从新到旧返回任务。
application/json
object必填const
"list"data必填array数组元素
next_cursor必填string | null
约束
required["object","data","next_cursor"]
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
获取图片任务
GET/v1/images/tasks/{task_id}
获取任务的提示词、参数、状态、图片和费用,须使用同一 Workspace 的 API Key。
请求参数
task_idpath · 必填string约束
pattern"^[A-Za-z0-9_-]{1,128}$"
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200图片任务详情。
application/json
id必填stringobject必填const
"image.task"model必填stringoperation必填enum
["images.generations","images.edits"]status必填content_status必填created_at必填stringdate-timecompleted_at必填string | nulldate-timeprompt必填stringparameters必填object提交此任务时使用的参数。
effective_parameters可选任务采用的尺寸、质量和张数,包含模型默认值。其他设置见 parameters。
size可选stringquality可选stringn可选integer
images必填array数组元素
billing必填error可选
约束
required["id","object","model","operation","status","content_status","created_at","completed_at","prompt","parameters","images","billing"]
同时满足 allOf
输出信息,有数据时返回。多张图片尺寸不同时省略顶层 size,各图片尺寸可在任务详情的 images 数组中查看。
background可选enum
["opaque","transparent"]output_format可选enum
["png","jpeg","webp"]size可选stringquality可选enum
["low","medium","high","xhigh","max"]usage可选
defaultHTTP 错误:400 输入或模型无效;401 API Key 缺失或无效;402 AI 余额不足;403 无权访问;404 任务不存在;409 幂等键冲突;410 上传或图片链接到期;413 请求过大;502 生成失败;503 服务暂不可用或结果待确认。若返回 X-Sukidata-Task-ID,请先查询原任务再重试。
application/json
error必填
约束
required["error"]
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
X-Sukidata-Task-IDheader · 可选任务创建后返回的 ID,可在超时后用于查询结果。
string
JEV 决策
POST/v1/systemone
使用 TypeSafe 的 System One 模型 JEV 分类文本、判断条件并为内容评分。在 state 中提供上下文,在 questions 中定义问题,同步返回答案和用量。
请求体 · 必填
JSON 请求体,最大 1 MiB。
application/json
model必填string使用
jev-latest跟随当前正式版本、jev-preview体验预览版本,或使用jev-1.13.0等版本 ID 固定版本。examples
["jev-latest","jev-preview","jev-1.13.0"]约束
minLength1maxLength128
state必填待判断的文本、JSON 对象或数组,每个问题独立使用这份上下文。
questions必填object以自定义名称组织问题。每项指定类型(
choice、noul或score)、问题说明及所需的判断标准。约束
minProperties1maxProperties1024
additionalProperties
约束
required["model","state","questions"]
additionalProperties
false
请求头
Authorization: Bearer $SUKIDATA_API_KEY
Idempotency-Keyheader · 可选每次新判断使用唯一的键。超时后保持此键、API Key 和 JSON 输入不变重试。已完成的请求返回原结果,不重复执行或收费。若返回 409 request_in_progress,等待后使用原键重试。更改输入或 API Key 返回 409 idempotency_conflict。省略或更换键会创建新的计费请求。
string约束
minLength1maxLength128pattern"^[!-~]+$"
响应
200结构化答案与请求用量。
application/json
id必填stringSukidata 判断请求 ID。
model必填string本次判断使用的模型版本。
answers必填objectadditionalPropertiestype必填enum
["noul","choice","score"]noul可选number条件成立的概率,而非强弱程度。接近 0.5 表示不确定。
约束
minimum0maximum1
choice可选string概率最高的选项的键。
score可选number从 0 开始的评价等级索引按概率加权得到的均值,可以为小数。
confidence可选numberchoice 和 score 根据分布计算的置信度,不等于答案正确的概率。noul 不返回此字段。
约束
minimum0maximum1
probabilities可选objectchoice 选项键或从 0 开始的 score 等级索引的概率分布。
additionalPropertiesnumber约束
minimum0maximum1
legend可选object将从 0 开始的 score 索引对应到传入的评价标准。
additionalPropertiestrue
约束
required["type"]
usage必填input_tokens必填integer约束
minimum0
output_tokens可选integer输出 token 用量,免费。
约束
minimum0
cost必填number本次判断的美元费用。
约束
minimum0
约束
required["input_tokens","cost"]
约束
required["id","model","answers","usage"]
响应头
X-Sukidata-Request-IDheader · 可选联系支持团队时需提供的请求 ID。
string
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
default400 输入无效或模型不可用;402 AI 余额不足;409 幂等冲突或请求处理中;413 请求体过大;502 判断失败;503 暂不可用。
application/json
仅满足其中一种 oneOf
message必填stringerror_type必填string
约束
required["message","error_type"]
查看 JEV 请求
GET/v1/decisions/{request_id}
查看当前 Workspace 内 JEV 请求已保存的输入和响应。查询不会运行模型或重复收费。结果尚未保存或判断失败时,响应可能为 null。
请求参数
request_idpath · 必填string约束
pattern"^[A-Za-z0-9_-]{1,128}$"
请求头
Authorization: Bearer $SUKIDATA_API_KEY
响应
200已保存的请求和响应。
application/json
id必填stringmodel必填string请求时指定的模型名称。
status必填执行状态,与计费状态独立。
enum
["authorizing","ready","running","succeeded","failed","unknown"]request必填response必填error_code可选stringcreated_at必填stringdate-time
约束
required["id","model","status","request","response","created_at"]
401API 密钥缺失、无效、未启用、已撤销或已过期。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
403此 API Key 无权访问。
application/json
响应头
X-Request-IDheader · 可选联系支持团队时需提供的请求标识。
default400 请求 ID 或查询参数无效;404 请求不存在;503 暂不可用。
application/json
message必填stringerror_type必填string
约束
required["message","error_type"]
数据结构
ImageReferenceFields
ImageReferenceFields
从 image 和 images 中选择一个字段,两者均支持单张参考图或数组。
image可选images可选
条件与其他约束
{
"not": {
"required": [
"image",
"images"
]
}
}ImageReferences
ImageReferences
ImageReference
ImageReference
仅满足其中一种 oneOf
string
公开 HTTPS 图片 URL,或 PNG、JPEG、WebP 的 Base64 data URL。
约束
minLength1
image_url可选string公开 HTTPS 图片 URL,或 PNG、JPEG、WebP 的 Base64 data URL。
约束
minLength1
b64_json可选stringBase64 编码的 PNG、JPEG 或 WebP 参考图。
约束
minLength1contentEncoding"base64"
additionalProperties
false
仅满足其中一种 oneOf
约束
required["image_url"]
约束
required["b64_json"]
ImageMask
ImageMask
带 alpha 通道的 PNG 蒙版,尺寸须与第一张参考图一致。透明区域指定编辑位置,蒙版不占用参考图数量名额。
同时满足 allOf
ImageMultipartFields
ImageMultipartFields
image可选stringbinaryPNG、JPEG 或 WebP 文件,多张图片使用重复的 image[] 字段。
image[]可选array约束
minItems1maxItems16
数组元素
stringbinary
DecisionRequest
DecisionRequest
model必填string使用
jev-latest跟随当前正式版本、jev-preview体验预览版本,或使用jev-1.13.0等版本 ID 固定版本。examples
["jev-latest","jev-preview","jev-1.13.0"]约束
minLength1maxLength128
state必填待判断的文本、JSON 对象或数组,每个问题独立使用这份上下文。
questions必填object以自定义名称组织问题。每项指定类型(
choice、noul或score)、问题说明及所需的判断标准。约束
minProperties1maxProperties1024
additionalProperties
约束
required["model","state","questions"]
additionalProperties
false
DecisionContent
DecisionContent
仅满足其中一种 oneOf
string
object
additionalProperties
true
array
数组元素
DecisionQuestion
DecisionQuestion
type必填enum
["noul","choice","score"]instructions可选针对共享上下文的一个明确、完整的问题。
criteria可选noul 可选的 true/false 描述;choice 的具名选项;score 由低到高、含明确描述的有序等级。
约束
required["type"]
同时满足 allOf
条件与其他约束
{
"if": {
"properties": {
"type": {
"const": "noul"
}
}
},
"then": {
"properties": {
"criteria": {
"type": [
"object",
"null"
],
"properties": {
"true": {
"$ref": "#/components/schemas/DecisionContent"
},
"false": {
"$ref": "#/components/schemas/DecisionContent"
}
}
}
}
}
}条件与其他约束
{
"if": {
"properties": {
"type": {
"const": "choice"
}
}
},
"then": {
"required": [
"criteria"
],
"properties": {
"criteria": {
"type": "object",
"minProperties": 1,
"maxProperties": 255,
"additionalProperties": {
"oneOf": [
{
"$ref": "#/components/schemas/DecisionContent"
},
{
"type": "null"
}
]
}
}
}
}
}条件与其他约束
{
"if": {
"properties": {
"type": {
"const": "score"
}
}
},
"then": {
"required": [
"criteria"
],
"properties": {
"criteria": {
"type": "array",
"minItems": 2,
"maxItems": 10,
"items": {
"$ref": "#/components/schemas/DecisionContent"
}
}
}
}
}DecisionDetail
DecisionDetail
id必填stringmodel必填string请求时指定的模型名称。
status必填执行状态,与计费状态独立。
enum
["authorizing","ready","running","succeeded","failed","unknown"]request必填response必填error_code可选stringcreated_at必填stringdate-time
约束
required["id","model","status","request","response","created_at"]
DecisionResponse
DecisionResponse
id必填stringSukidata 判断请求 ID。
model必填string本次判断使用的模型版本。
answers必填objectadditionalPropertiestype必填enum
["noul","choice","score"]noul可选number条件成立的概率,而非强弱程度。接近 0.5 表示不确定。
约束
minimum0maximum1
choice可选string概率最高的选项的键。
score可选number从 0 开始的评价等级索引按概率加权得到的均值,可以为小数。
confidence可选numberchoice 和 score 根据分布计算的置信度,不等于答案正确的概率。noul 不返回此字段。
约束
minimum0maximum1
probabilities可选objectchoice 选项键或从 0 开始的 score 等级索引的概率分布。
additionalPropertiesnumber约束
minimum0maximum1
legend可选object将从 0 开始的 score 索引对应到传入的评价标准。
additionalPropertiestrue
约束
required["type"]
usage必填input_tokens必填integer约束
minimum0
output_tokens可选integer输出 token 用量,免费。
约束
minimum0
cost必填number本次判断的美元费用。
约束
minimum0
约束
required["input_tokens","cost"]
约束
required["id","model","answers","usage"]
AIModel
AIModel
id必填stringobject必填const
"model"created必填integerint64以秒为单位的 Unix 时间戳。
owned_by必填const
"sukidata"
约束
required["id","object","created","owned_by"]
ImageRequestFields
ImageRequestFields
model必填string/v1/models 返回的可用模型 ID,例如 gpt-image-2.5 或 gpt-image-2。
约束
minLength1maxLength128
prompt必填string约束
minLength1maxLength32000
size可选string请求尺寸为 auto 或 WIDTHxHEIGHT。宽高须为不超过 3840 的正整数,宽高比介于 1:3 和 3:1,总像素介于 655360 和 8294400。省略时使用模型默认值。
约束
minLength1maxLength32pattern"^(auto|[1-9][0-9]{0,3}x[1-9][0-9]{0,3})$"
quality可选string所选模型支持的质量,省略时使用模型默认值。
约束
minLength1maxLength16
n可选integer生成图片的张数,受所选模型上限限制。gpt-image-2.5 和 gpt-image-2 每次支持 1–4 张,默认 1 张。
约束
minimum1maximum10
output_format可选stringenum
["png","jpeg","webp"]default
"png"background可选string透明背景输出须使用 PNG 或 WebP。
enum
["auto","opaque","transparent"]moderation可选stringenum
["auto","low"]output_compression可选integerJPEG 和 WebP 的输出压缩参数,PNG 接收此参数但不应用。
约束
minimum0maximum100
response_format可选string同步响应的交付格式。异步任务通过详情中的公共图片 URL 交付。
enum
["b64_json","url"]default
"b64_json"stream可选boolean设为 false 或省略,需要后台生成时使用异步接口。
const
falseuser可选string调用方的终端用户标识,随任务保存。
约束
maxLength256
约束
required["model","prompt"]
ImageResult
ImageResult
created必填integerint64任务创建时间,以秒为单位的 Unix 时间戳。
data必填array约束
minItems1
数组元素
b64_json可选string约束
contentEncoding"base64"
url可选stringuri图片 URL,自发布起可用 31 天,持有链接的人均可查看。
additionalPropertiesfalse仅满足其中一种
oneOf约束
required["b64_json"]
约束
required["url"]
约束
required["created","data"]
同时满足 allOf
ImageResultMetadata
ImageResultMetadata
输出信息,有数据时返回。多张图片尺寸不同时省略顶层 size,各图片尺寸可在任务详情的 images 数组中查看。
background可选enum
["opaque","transparent"]output_format可选enum
["png","jpeg","webp"]size可选stringquality可选enum
["low","medium","high","xhigh","max"]usage可选
ImageTokenUsage
ImageTokenUsage
Token 用量,有数据时返回;按张计费不会额外收取 token 费用。
input_tokens必填integer约束
minimum0
output_tokens必填integer约束
minimum0
total_tokens必填integer约束
minimum0
input_tokens_details可选output_tokens_details可选
约束
required["input_tokens","output_tokens","total_tokens"]
ImageTokenDetails
ImageTokenDetails
text_tokens可选integer约束
minimum0
image_tokens可选integer约束
minimum0
cached_tokens可选integer约束
minimum0
ImageTaskStatus
ImageTaskStatus
string
任务进度。unknown 表示结果尚未确认,并非已确认失败;请继续查询同一个任务。
enum["queued","processing","completed","failed","unknown"]
ImageContentStatus
ImageContentStatus
string
生成图片文件的可用状态。
enum["pending","ready","unavailable"]
ImageTaskSummary
ImageTaskSummary
id必填stringmodel必填stringoperation必填enum
["images.generations","images.edits"]prompt_preview必填stringstatus必填content_status必填billing_status必填string计费状态,已完成任务的费用可能仍待确认。
billing必填api_key_id必填string | null提交任务时使用的 API Key ID,无法获取时为 null。
image_count必填integer本次响应中可获取的生成图片数量。
约束
minimum0
images必填array图片链接与到期时间,图片就绪前为空。
数组元素
index必填integer约束
minimum0
url必填stringuriurl_expires_at可选stringdate-time公开链接到期时间。请在到期前保存图片,到期后无法通过 API 取回。
thumbnail_url可选stringuri缩略图就绪后返回此链接,与原图同时到期。完整分辨率图片请使用 url。
width必填integer原图宽度,单位为像素。
约束
minimum1
height必填integer原图高度,单位为像素。
约束
minimum1
约束
required["index","url","width","height"]
created_at必填stringdate-timecompleted_at必填string | nulldate-timeurl必填stringuri任务详情地址,需要 API 鉴权。
约束
required["id","model","operation","prompt_preview","status","content_status","billing_status","billing","api_key_id","image_count","images","created_at","completed_at","url"]
ImageFile
ImageFile
index必填integer约束
minimum0
url必填stringuriurl_expires_at可选stringdate-time公开链接到期时间。请在到期前保存图片,到期后无法通过 API 取回。
thumbnail_url可选stringuri缩略图就绪后返回此链接,与原图同时到期。完整分辨率图片请使用 url。
width必填integer约束
minimum1
height必填integer约束
minimum1
format必填enum
["png","jpeg","webp"]
约束
required["index","url","width","height","format"]
ImageTask
ImageTask
id必填stringobject必填const
"image.task"model必填stringoperation必填enum
["images.generations","images.edits"]status必填content_status必填created_at必填stringdate-timecompleted_at必填string | nulldate-timeprompt必填stringparameters必填object提交此任务时使用的参数。
effective_parameters可选任务采用的尺寸、质量和张数,包含模型默认值。其他设置见 parameters。
size可选stringquality可选stringn可选integer
images必填array数组元素
billing必填error可选
约束
required["id","object","model","operation","status","content_status","created_at","completed_at","prompt","parameters","images","billing"]
同时满足 allOf
ImageBilling
ImageBilling
balance_type必填const
"ai"currency必填const
"USD"status必填string计费状态,unavailable 时金额字段为 null。
enum
["pending","reserved","review","settled","released","rejected","unavailable"]reserved_amount必填string | null当前为此任务预留的美元金额,待确认或暂不可用时为 null。
约束
pattern"^[0-9]+\\.[0-9]{9}$"
charged_amount必填string | null更正后的实际美元费用,待确认或暂不可用时为 null。
约束
pattern"^[0-9]+\\.[0-9]{9}$"
original_charged_amount可选string | null更正前的原始美元费用,待确认或暂不可用时为 null。
约束
pattern"^[0-9]+\\.[0-9]{9}$"
credited_amount可选string | null此任务退回 AI 余额的美元金额,待确认或暂不可用时为 null。
约束
pattern"^[0-9]+\\.[0-9]{9}$"
约束
required["balance_type","currency","status","reserved_amount","charged_amount"]
ImageErrorDetail
ImageErrorDetail
code必填stringmessage必填stringtype可选string
约束
required["code","message"]
RequestID
RequestID
string
约束
minLength1maxLength128pattern"^[!-~]+$"
ErrorEnvelope
ErrorEnvelope
ActivityList
ActivityList
data必填array数组元素
cursor可选string传入下一次请求的游标;当
has_more=false时不返回。has_more必填boolean
约束
required["data","has_more"]
additionalProperties
false
ActivityItem
ActivityItem
search_id必填stringrequest_id可选string联系支持团队时需提供的请求 ID。
api_key_id可选string原始搜索请求使用的 API 密钥 ID。
product必填stringengine必填stringstatus必填stringenum
["Queued","Processing","Success","Error"]cache_hit必填boolean该搜索是否符合零积分缓存响应条件。
credits_used可选integerint64该搜索消耗的积分;在状态变为
Success或Error前不返回。q可选string搜索查询词(如有)。
search_parameters可选object可在其他请求中复用的搜索参数。
additionalPropertiestruelocation_requested可选stringlocation_used可选stringgoogle_url可选stringurierror_code可选string搜索失败时返回的错误代码。
const
"search_failed"error_message可选string搜索失败时返回的错误信息。
const
"Search request failed"json_endpoint可选stringuriJSON 结果文件,搜索达到
Success或Error状态后可用。raw_html_file可选stringuriHTML 结果文件,搜索结束且文件可用时返回。
created_at必填stringdate-timecompleted_at可选stringdate-time
约束
required["search_id","product","engine","status","cache_hit","created_at"]
additionalProperties
false
GoogleLocations
GoogleLocations
GoogleSupport
GoogleSupport
domains必填countries必填languages必填cr_countries必填lr_languages必填
约束
required["domains","countries","languages","cr_countries","lr_languages"]
additionalProperties
false
StringList
StringList
array
数组元素
string
GoogleLocation
GoogleLocation
id必填stringgoogle_id必填integerint64google_parent_id可选integerint64name必填stringcanonical_name必填stringcountry_code必填stringtarget_type必填stringreach必填integerint64gps可选array约束
minItems2maxItems2
数组元素
number
约束
required["id","google_id","name","canonical_name","country_code","target_type","reach"]
additionalProperties
false
SERPRequest
SERPRequest
Google SERP 请求参数。字符串字段会去除首尾空白;除非字段另有更小限制,最大为 4096 个 UTF-8 字节。
engine可选stringenum
["google"]default
"google"约束
maxLength4096
q必填stringGoogle 搜索查询词,支持 site:、inurl:、intitle: 等高级运算符。
约束
minLength1maxLength4096pattern"\\S"
as_dt可选string | null与 as_sitesearch 配合使用,用于包含或排除网站的 Google 高级搜索参数。
约束
maxLength4096
as_epq可选string | nullGoogle 高级搜索中的精确短语查询。
约束
maxLength4096
as_eq可选string | nullGoogle 高级搜索中要排除的查询词。
约束
maxLength4096
as_lq可选string | nullGoogle 高级搜索中的链接页面查询 URL。
约束
maxLength4096
as_nlo可选string | nullGoogle 高级搜索数值范围的下限。
约束
maxLength4096
as_nhi可选string | nullGoogle 高级搜索数值范围的上限。
约束
maxLength4096
as_oq可选string | nullGoogle 高级搜索中的可选查询词。
约束
maxLength4096
as_q可选string | nullGoogle 高级搜索中的附加查询词。
约束
maxLength4096
as_qdr可选string | nullGoogle 高级搜索的快捷日期范围,例如 d10、w2、m1 或 y。
约束
maxLength4096
as_rq可选string | nullGoogle 高级搜索中的相关页面查询 URL。
约束
maxLength4096
as_sitesearch可选string | nullGoogle 高级搜索中要限制或排除的网站。
约束
maxLength4096
location可选string | nullGET /v1/serp/locations 返回的 Google 搜索位置名称或 ID;不能与 uule 同时使用。
约束
maxLength4096
google_domain可选string不含协议和路径的 Google 搜索域名,例如 google.com、google.de、google.co.jp 或 google.com.br。输入不区分大小写,会转为小写并按支持列表校验。
default
"google.com"约束
maxLength4096pattern"^[Gg][Oo][Oo][Gg][Ll][Ee](?:\\.[Cc][Oo][Mm]|\\.[A-Za-z]{2}|\\.(?:[Cc][Oo][Mm]|[Cc][Oo])\\.[A-Za-z]{2})$"
gl可选string两位 Google 国家或地区代码。输入不区分大小写,会转为小写并按支持列表校验。
default
"us"约束
minLength2maxLength2pattern"^[A-Za-z]{2}$"
hl可选stringGoogle 界面语言代码,例如 en、ja、pt-br 或 zh-cn。输入会转为小写并按支持列表校验。
default
"en"约束
minLength2maxLength32pattern"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$"
uule可选string | nullGoogle 编码位置;不能与 location 同时使用。
约束
maxLength4096
lat可选用于 Google GPS 定位的纬度。必须与 lon 同时使用,且不能与 location 或 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum-90maximum90
string约束
pattern"^-?(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nulllon可选用于 Google GPS 定位的经度。必须与 lat 同时使用,且不能与 location 或 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum-180maximum180
string约束
pattern"^-?(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nullradius可选位置或 GPS 定位的搜索半径。桌面设备最大为 199,平板或移动设备最大为 1000;不能与 uule 同时使用。
仅满足其中一种
oneOfnumber约束
minimum1
string约束
pattern"^(?:\\d+|\\d*\\.\\d+)(?:[eE][+-]?\\d+)?$"
nullludocid可选string | null地点结果的 Google CID。
约束
maxLength4096
lsig可选string | null部分本地结果和知识图谱视图使用的 Google lsig 值。
约束
maxLength4096
kgmid可选string | nullGoogle 知识图谱实体 ID。
约束
maxLength4096
si可选string | nullGoogle 加密或缓存搜索参数令牌。
约束
maxLength4096
ibp可选string | nullGoogle 布局或展开参数。
约束
maxLength4096
uds可选string | nullSERP 筛选链接返回的 Google 筛选令牌。
约束
maxLength4096
cr可选string | nullGoogle 国家或地区限制筛选器。使用一个或多个以
|分隔的 countryXX 令牌,例如countryUS|countryJP。约束
maxLength4096
lr可选string | nullGoogle 语言限制筛选器。使用一个或多个以
|分隔的 lang_xx 令牌,例如lang_en|lang_zh-CN。约束
maxLength4096
tbs可选string | null约束
maxLength4096
tbm可选string | null支持的 Google 搜索类型;普通 Google 搜索请省略该参数。
enum
["isch","lcl","vid","nws","shop","pts",null]约束
maxLength4096
safe可选stringenum
["off","active"]default
"off"约束
maxLength4096
nfpr可选booleandefault
falsefilter可选booleandefault
truestart可选integerdefault
0约束
minimum0
device可选stringenum
["desktop","tablet","mobile"]default
"desktop"约束
maxLength4096
async可选boolean为 false 时,API 等待搜索结果,也可能返回可轮询的处理中响应;为 true 时,API 立即返回可轮询的搜索响应。
default
falseno_cache可选booleandefault
falsewebhook可选
约束
required["q"]
additionalProperties
false
TwitterRequest
TwitterRequest
获取一页 Twitter 用户公开时间线的参数;必须且只能提供一个用户标识。
username可选stringTwitter 用户名,可带或不带前导
@。约束
minLength1maxLength51pattern"^@?[A-Za-z0-9_]+$"
user_id可选string数字格式的 Twitter 用户 ID。
约束
minLength1maxLength32pattern"^[0-9]+$"
max_results可选integer本页最多返回的帖子数量。
default
20约束
minimum1maximum100
cursor可选string上一次请求返回的不透明
next_cursor值。约束
minLength1maxLength8192
async可选boolean为 false 时,API 等待搜索结果,也可能返回可轮询的处理中响应;为 true 时,API 立即返回可轮询的搜索响应。
default
falsewebhook可选
additionalProperties
false
仅满足其中一种 oneOf
约束
required["username"]
条件与其他约束
{
"not": {
"required": [
"user_id"
]
}
}约束
required["user_id"]
条件与其他约束
{
"not": {
"required": [
"username"
]
}
}WebhookConfig
WebhookConfig
url必填stringuri使用公开主机名且不含用户名或密码的 HTTPS Webhook URL。不接受 localhost、私有 IP、特殊用途 IP 范围及 Sukidata 系统请求头覆盖;不会跟随重定向。
约束
pattern"^https://"
headers可选object可选的自定义请求头。名称必须是有效的 HTTP 请求头字段名,系统会将其规范化并拒绝不区分大小写的重复项;值不能包含多行,且 x-sukidata- 前缀为保留项。
additionalPropertiesstringevents可选arraydefault
["serp.search.completed","serp.search.failed"]约束
minItems1uniqueItemstrue
数组元素
stringenum
["serp.search.queued","serp.search.processing","serp.search.completed","serp.search.failed"]
约束
required["url"]
additionalProperties
false
TwitterWebhookConfig
TwitterWebhookConfig
url必填stringuri使用公开主机名且不含用户名或密码的 HTTPS Webhook URL。不接受 localhost、私有 IP、特殊用途 IP 范围及 Sukidata 系统请求头覆盖;不会跟随重定向。
约束
pattern"^https://"
headers可选object可选的自定义请求头。名称必须是有效的 HTTP 请求头字段名,系统会将其规范化并拒绝不区分大小写的重复项;值不能包含多行,且 x-sukidata- 前缀为保留项。
additionalPropertiesstringevents可选arraydefault
["twitter.search.completed","twitter.search.failed"]约束
minItems1uniqueItemstrue
数组元素
stringenum
["twitter.search.queued","twitter.search.processing","twitter.search.completed","twitter.search.failed"]
约束
required["url"]
additionalProperties
false
WebhookPayload
WebhookPayload
id必填stringWebhook 通知或事件 ID,与
X-Sukidata-Delivery一致。object必填stringconst
"event"type必填stringenum
["serp.search.queued","serp.search.processing","serp.search.completed","serp.search.failed"]api_version必填stringconst
"v1"created_at必填stringdate-timedata必填
约束
required["id","object","type","api_version","created_at","data"]
additionalProperties
false
WebhookData
WebhookData
WebhookSearchObject
WebhookSearchObject
id必填stringobject必填stringconst
"search"endpoint必填stringconst
"/v1/serp"url必填stringuri用于获取搜索状态或结果的已认证 API URL。
search_metadata必填search_parameters必填search_information可选organic_results可选arrayusage必填error可选
约束
required["id","object","endpoint","url","search_metadata","search_parameters","usage"]
additionalProperties
true
SearchMetadata
SearchMetadata
id必填stringstatus必填stringenum
["Queued","Processing","Success","Error"]json_endpoint可选stringuri该搜索的 JSON 快照 URL。搜索状态变为
Success或Error后可用,并保留一个月。URL 无需 API 认证,请勿公开。raw_html_file可选stringuri该搜索的 HTML 快照 URL(如有)。文件保留一个月且无需 API 认证,请勿公开。
google_url可选stringuri与该结果对应的 Google 搜索 URL。
created_at必填stringdate-time搜索创建时间。
processed_at可选stringdate-time搜索结束时间。
total_time_taken必填number搜索耗时,单位为秒,最多保留两位小数。Google 页面显示的 SERP 耗时(如有)位于
search_information.time_taken_displayed。约束
minimum0
约束
required["id","status","created_at","total_time_taken"]
additionalProperties
false
WebhookUsageFields
WebhookUsageFields
cache_hit必填boolean该搜索是否符合零积分缓存响应条件。
credits_used可选integerint64该搜索消耗的积分。
约束
required["cache_hit"]
additionalProperties
false
ErrorDetail
ErrorDetail
code必填stringconst
"search_failed"message必填stringconst
"Search request failed"
约束
required["code","message"]
additionalProperties
false
SearchParameters
SearchParameters
engine必填stringconst
"google"约束
maxLength4096
q必填string约束
minLength1maxLength4096pattern"\\S"
location_requested可选string请求提供
location时,调用方传入的原始可读位置。约束
maxLength4096
location_used可选string请求提供
location时,匹配到的 Google 位置。约束
maxLength4096
as_dt可选string | null约束
maxLength4096
as_epq可选string | null约束
maxLength4096
as_eq可选string | null约束
maxLength4096
as_lq可选string | null约束
maxLength4096
as_nlo可选string | null约束
maxLength4096
as_nhi可选string | null约束
maxLength4096
as_oq可选string | null约束
maxLength4096
as_q可选string | null约束
maxLength4096
as_qdr可选string | null约束
maxLength4096
as_rq可选string | null约束
maxLength4096
as_sitesearch可选string | null约束
maxLength4096
google_domain必填string约束
maxLength4096pattern"^google(?:\\.com|\\.[a-z]{2}|\\.(?:com|co)\\.[a-z]{2})$"
gl必填string约束
minLength2maxLength2pattern"^[a-z]{2}$"
hl必填string约束
minLength2maxLength32pattern"^[a-z]{2,3}(?:-[a-z0-9]{2,8})*$"
uule可选string | null约束
maxLength4096
ludocid可选string | null约束
maxLength4096
lsig可选string | null约束
maxLength4096
kgmid可选string | null约束
maxLength4096
si可选string | null约束
maxLength4096
ibp可选string | null约束
maxLength4096
uds可选string | null约束
maxLength4096
cr可选string | null约束
maxLength4096
lr可选string | null约束
maxLength4096
tbs可选string | null约束
maxLength4096
tbm可选string | null约束
maxLength4096
safe可选stringenum
["off","active"]约束
maxLength4096
nfpr可选booleanfilter可选booleanstart可选integer约束
minimum0
device必填stringenum
["desktop","tablet","mobile"]约束
maxLength4096
约束
required["engine","q","google_domain","gl","hl","device"]
additionalProperties
false
SERPSearchEnvelope
SERPSearchEnvelope
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
SERPEnvelope
SERPEnvelope
SERPCompletedResultEnvelope
SERPCompletedResultEnvelope
search_metadata必填search_parameters必填search_information必填organic_results可选arrayads可选array数组元素
answer_box可选ai_overview可选knowledge_graph可选local_results可选top_stories可选array数组元素
images_results可选array数组元素
videos_results可选array数组元素
shopping_results可选arrayrelated_questions可选related_searches可选arraypagination可选
约束
required["search_metadata","search_parameters","search_information"]
additionalProperties
true
SERPFailedResultEnvelope
SERPFailedResultEnvelope
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
SERPSearchInformation
SERPSearchInformation
来自 Google 结果页和请求的搜索信息。
query_displayed必填string约束
minLength1
total_results可选integer约束
minimum0
time_taken_displayed可选numberGoogle 在 SERP 页面显示的耗时(如有),单位为秒;该值与
search_metadata.total_time_taken相互独立。约束
minimum0
约束
required["query_displayed"]
additionalProperties
true
SERPOrganicResult
SERPOrganicResult
结构化 Google 自然搜索结果。
position必填integer从 1 开始的 SERP 结果排名。项目必须按数组顺序严格递增,且不能重复。
约束
minimum1
title必填string约束
minLength1
link必填stringuri最终 HTTP(S) 目标 URL。
displayed_link可选stringGoogle 显示的 URL 文本(如有);否则使用结果主机名。
source可选stringGoogle 显示的来源标签(如有);否则使用结果主机名。
约束
minLength1
snippet必填stringSERP 提供的摘要;Google 未提供摘要时允许为空字符串。
snippet_highlighted_words可选array数组元素
stringfavicon可选string网站图标 URL(如有),不能是 data URL。
date可选stringsitelinks可选objectadditionalPropertiestrueabout_this_result可选objectadditionalPropertiestrueabout_page_link可选stringuri
约束
required["position","title","link","snippet"]
additionalProperties
true
SERPLinkedResult
SERPLinkedResult
解析后的带链接 SERP 富媒体卡片,用于广告、焦点新闻和视频。
position必填integer约束
minimum1
title必填string约束
minLength1
link必填stringurisource可选stringsnippet可选stringdate可选string
约束
required["position","title","link"]
additionalProperties
true
SERPImageResult
SERPImageResult
position必填integer约束
minimum1
title必填string约束
minLength1
link可选stringurithumbnail可选stringuri
约束
required["position","title"]
additionalProperties
true
SERPShoppingResult
SERPShoppingResult
position必填integer约束
minimum1
title必填string约束
minLength1
link可选stringuriprice可选stringsource可选stringthumbnail可选stringuri
约束
required["position","title"]
additionalProperties
true
SERPAIOverview
SERPAIOverview
Google AI Overview 内容(如有)。
status可选stringenum
["success","unavailable","fetch_failed"]page_token可选stringGoogle AI Overview 页面令牌(如有)。
message可选string无法返回 Overview 时的可用性说明。
error可选string无法获取 Overview 内容时的失败原因。
text_blocks可选arrayreferences可选array
additionalProperties
true
SERPAIOverviewTextBlock
SERPAIOverviewTextBlock
type必填stringenum
["heading","paragraph","list_item"]snippet必填string约束
minLength1
约束
required["type","snippet"]
additionalProperties
true
SERPAIOverviewReference
SERPAIOverviewReference
index必填integer约束
minimum1
title必填string约束
minLength1
link必填stringurisource必填string约束
minLength1
snippet可选string
约束
required["index","title","link","source"]
additionalProperties
true
SERPRelatedQuestion
SERPRelatedQuestion
question必填string约束
minLength1
type可选stringenum
["ai_overview","featured_snippet"]page_token可选stringnext_page_token可选stringlink可选stringuridisplayed_link可选stringtitle可选stringsnippet可选stringdate可选stringsource_logo可选stringuri
约束
required["question"]
additionalProperties
true
SERPRelatedSearch
SERPRelatedSearch
query必填string约束
minLength1
link可选stringuri
约束
required["query"]
additionalProperties
true
SERPLocalResults
SERPLocalResults
places可选array数组元素
more_locations_link可选stringurimap可选image可选stringurilink可选stringuri
additionalPropertiestrue
additionalProperties
true
SERPLocalPlace
SERPLocalPlace
position必填integer约束
minimum1
title必填string约束
minLength1
place_id可选stringlink可选stringurirating可选numberreviews可选integer约束
minimum0
type可选stringaddress可选string
约束
required["position","title"]
additionalProperties
true
SERPAnswerBox
SERPAnswerBox
type可选stringanswer可选stringtitle可选stringlink可选stringuridisplayed_link可选stringsource可选string
additionalProperties
true
SERPKnowledgeGraph
SERPKnowledgeGraph
title可选stringtype可选stringdescription可选stringsource可选name可选stringlink可选stringuri
additionalPropertiestrue
additionalProperties
true
SERPPagination
SERPPagination
next可选stringuri
additionalProperties
true
TwitterSearchParameters
TwitterSearchParameters
engine必填stringconst
"twitter"username可选string约束
minLength1maxLength50pattern"^[A-Za-z0-9_]+$"
user_id可选string约束
minLength1maxLength32pattern"^[0-9]+$"
max_results必填integer约束
minimum1maximum100
cursor可选string约束
minLength1maxLength8192
约束
required["engine","max_results"]
additionalProperties
false
仅满足其中一种 oneOf
约束
required["username"]
条件与其他约束
{
"not": {
"required": [
"user_id"
]
}
}约束
required["user_id"]
条件与其他约束
{
"not": {
"required": [
"username"
]
}
}TwitterSearchEnvelope
TwitterSearchEnvelope
search_metadata必填search_parameters必填
约束
required["search_metadata","search_parameters"]
additionalProperties
false
TwitterEnvelope
TwitterEnvelope
TwitterCompletedResultEnvelope
TwitterCompletedResultEnvelope
search_metadata必填search_parameters必填user必填tweets必填next_cursor可选string下一页的不透明游标;没有下一页时不返回。
约束
minLength1maxLength8192
约束
required["search_metadata","search_parameters","user","tweets"]
additionalProperties
false
TwitterFailedResultEnvelope
TwitterFailedResultEnvelope
search_metadata必填search_parameters必填error必填
约束
required["search_metadata","search_parameters","error"]
additionalProperties
false
TwitterUser
TwitterUser
id必填string约束
minLength1maxLength64
username可选string约束
minLength1maxLength64
name可选stringdescription可选stringprofile_image_url可选stringuriverified可选booleanfollowers_count可选integer约束
minimum0
following_count可选integer约束
minimum0
tweet_count可选integer约束
minimum0
约束
required["id"]
additionalProperties
false
TwitterTweet
TwitterTweet
id必填string约束
minLength1maxLength64
text必填stringcreated_at可选stringdate-time帖子发布时间(UTC),有数据时返回。
language可选stringurl可选stringuriauthor可选metrics可选conversation_id可选string
约束
required["id","text"]
additionalProperties
false
TwitterMetrics
TwitterMetrics
like_count可选integer约束
minimum0
retweet_count可选integer约束
minimum0
reply_count可选integer约束
minimum0
quote_count可选integer约束
minimum0
bookmark_count可选integer约束
minimum0
view_count可选integer约束
minimum0
additionalProperties
false
TwitterWebhookPayload
TwitterWebhookPayload
id必填stringWebhook 通知或事件 ID,与
X-Sukidata-Delivery一致。object必填stringconst
"event"type必填stringenum
["twitter.search.queued","twitter.search.processing","twitter.search.completed","twitter.search.failed"]api_version必填stringconst
"v1"created_at必填stringdate-timedata必填
约束
required["id","object","type","api_version","created_at","data"]
additionalProperties
false
TwitterWebhookData
TwitterWebhookData
TwitterWebhookSearchObject
TwitterWebhookSearchObject
id必填stringobject必填stringconst
"search"endpoint必填stringconst
"/v1/twitter"url必填stringuri用于获取搜索状态或结果的已认证 API URL。
search_metadata必填search_parameters必填user可选tweets可选next_cursor可选string约束
minLength1maxLength8192
usage必填error可选
约束
required["id","object","endpoint","url","search_metadata","search_parameters","usage"]
additionalProperties
false
ErrorBody
ErrorBody
code必填string约束
maxLength80pattern"^[a-z][a-z0-9_]*$"
message必填string约束
minLength1maxLength240
约束
required["code","message"]
additionalProperties
false