{ "openapi": "3.0.3", "info": { "title": "GEO 服务商开放接口", "version": "1.3.0", "description": "服务商独立 Bearer 密钥。按客户唯一 ID 隔离数据和余额，独立配置平台与接口销售价；请求次数仅作统计，不限制调用。成功响应保持 v1 原有结构；失败统一返回 error、code、requestId。" }, "servers": [ { "url": "https://118.89.28.187/api/v1", "description": "线上接口服务地址（文档可独立部署）" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "read" }, { "name": "monitor" }, { "name": "provision" } ], "paths": { "/platforms": { "get": { "operationId": "platforms.list", "summary": "平台目录", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Platform" } } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/usage": { "get": { "operationId": "usage.get", "summary": "密钥用量", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/screenshots/{assetId}": { "get": { "operationId": "screenshots.get", "summary": "查看截图", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket", "in": "query", "schema": { "type": "string" }, "description": "查询任务获得的短期签名，仅可访问这一张图片，不能替代其他接口密钥。" } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "bearerAuth": [] }, { "imageTicket": [] } ] } }, "/brands": { "post": { "operationId": "brands.create", "summary": "创建品牌", "tags": [ "provision" ], "description": "需要 provision 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "description": "采集接口必填，其他收费写入接口也必须提供；同客户同接口同键同参重试不重复扣款，同键异参返回 409。", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,80}$" } } ], "responses": { "201": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Brand" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "aliases": { "type": "array", "items": { "type": "string", "maxLength": 100 }, "maxItems": 20 } }, "required": [ "name" ] } } } } }, "get": { "operationId": "brands.list", "summary": "品牌列表", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" } } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/brands/{brandId}/questions": { "post": { "operationId": "questions.create", "summary": "添加问题", "tags": [ "provision" ], "description": "需要 provision 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "采集接口必填，其他收费写入接口也必须提供；同客户同接口同键同参重试不重复扣款，同键异参返回 409。", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,80}$" } } ], "responses": { "201": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "questions": { "type": "array", "items": { "$ref": "#/components/schemas/Question" } }, "created": { "type": "integer" } }, "required": [ "questions", "created" ] } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "texts": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2000 }, "minItems": 1, "maxItems": 100 }, "category": { "type": "string", "maxLength": 100 } }, "required": [ "texts" ] } } } } }, "get": { "operationId": "questions.list", "summary": "问题列表", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Question" } } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/runs": { "post": { "operationId": "runs.create", "summary": "发起采集", "tags": [ "monitor" ], "description": "需要 monitor 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "采集接口必填，其他收费写入接口也必须提供；同客户同接口同键同参重试不重复扣款，同键异参返回 409。", "schema": { "type": "string", "pattern": "^[A-Za-z0-9_.-]{1,80}$" } } ], "responses": { "202": { "description": "已入队或复用既有任务；不代表采集成功。", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedRun" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRun" } } } } } }, "/runs/{runId}": { "get": { "operationId": "runs.get", "summary": "任务与回答", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Run" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/runs/{runId}/report": { "get": { "operationId": "reports.get", "summary": "采样报告", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/brands/{brandId}/runs": { "get": { "operationId": "runs.list", "summary": "任务列表", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Run" } } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/brands/{brandId}/overview": { "get": { "operationId": "overview.get", "summary": "品牌概览", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 3650, "default": 30 } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Overview" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/brands/{brandId}/sources": { "get": { "operationId": "sources.list", "summary": "引用来源", "tags": [ "read" ], "description": "需要 read 权限。无每日、每分钟或每小时次数限额。按客户接口销售价扣款，默认免费；收费查询按每次成功请求收费。", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 3650, "default": 30 } }, { "name": "platformId", "in": "query", "schema": { "type": "string", "enum": [ "deepseek", "doubao", "kimi", "qwen", "yuanbao", "doubao_mobile", "yuanbao_mobile", "deepseek_mobile", "baiduai", "baidu_mobile", "qianwen_mobile", "antafu", "quark", "weibo_zhisou", "douyinai", "chatgpt", "googleai", "bingai_overviews", "xiaohongshu_mobile" ] } } ], "responses": { "200": { "description": "成功", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sources" } } } }, "400": { "description": "参数错误", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "密钥无效、过期或撤销", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "余额不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "接口关闭、密钥关闭、未生效或权限不足", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "资源不存在", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "幂等冲突", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "图片已超过保留期限", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "上游服务繁忙", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } }, "Retry-After": { "description": "建议等待秒数。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "服务器异常", "headers": { "X-Request-Id": { "description": "服务器生成的请求追踪编号。", "schema": { "type": "string" } }, "X-Billing-Charged-Cents": { "description": "本次请求实际扣费（分），幂等重试为 0。", "schema": { "type": "integer" } }, "X-Balance-Cents": { "description": "本次扣费后的客户余额（分）。", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "imageTicket": { "type": "apiKey", "in": "query", "name": "ticket" }, "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Key" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" } }, "required": [ "error", "code", "requestId" ] }, "DailyUsage": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "timezone": { "type": "string", "enum": [ "Asia/Shanghai" ] }, "limit": { "type": "integer" }, "used": { "type": "integer" }, "remaining": { "type": "integer", "nullable": true }, "resetAt": { "type": "string", "format": "date-time" } }, "required": [ "date", "timezone", "limit", "used", "remaining", "resetAt" ] }, "Usage": { "type": "object", "properties": { "customerId": { "type": "string" }, "balanceCents": { "type": "integer" }, "pricing": { "$ref": "#/components/schemas/Pricing" }, "startsAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "dailyUsage": { "$ref": "#/components/schemas/DailyUsage" } }, "required": [ "startsAt", "expiresAt", "dailyUsage" ] }, "Brand": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "website": { "type": "string" }, "products": { "type": "array", "items": { "type": "string" } }, "ownedDomains": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name" ] }, "Question": { "type": "object", "properties": { "id": { "type": "string" }, "brandId": { "type": "string" }, "text": { "type": "string" }, "category": { "type": "string" }, "enabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "text", "enabled" ] }, "PlatformPrice": { "type": "object", "properties": { "currency": { "type": "string" }, "unit": { "type": "string" }, "webCents": { "type": "integer" }, "mobileCents": { "type": "integer" }, "updatedAt": { "type": "string", "format": "date-time" }, "platformId": { "type": "string" }, "baseCents": { "type": "integer", "nullable": true }, "screenshotCents": { "type": "integer" }, "configured": { "type": "boolean" }, "overridden": { "type": "boolean" } } }, "Pricing": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "CNY" ] }, "unit": { "type": "string", "enum": [ "question_platform_sample" ] }, "webCents": { "type": "integer" }, "mobileCents": { "type": "integer" }, "updatedAt": { "type": "string", "format": "date-time" }, "platforms": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformPrice" } }, "operations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "baseCents": { "type": "integer" } } } } } }, "Platform": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "deepseek", "doubao", "kimi", "qwen", "yuanbao", "doubao_mobile", "yuanbao_mobile", "deepseek_mobile", "baiduai", "baidu_mobile", "qianwen_mobile", "antafu", "quark", "weibo_zhisou", "douyinai", "chatgpt", "googleai", "bingai_overviews", "xiaohongshu_mobile" ] }, "name": { "type": "string" }, "label": { "type": "string" }, "client": { "type": "string", "enum": [ "web", "mobile" ] }, "upstreamId": { "type": "string" }, "browserSupported": { "type": "boolean" }, "goodsSupported": { "type": "boolean" }, "supportedCollectors": { "type": "array", "items": { "type": "string" } }, "defaultMode": { "type": "string" }, "upstreamConfigured": { "type": "boolean" }, "pricing": { "$ref": "#/components/schemas/PlatformPrice" } }, "required": [ "id", "name", "client", "pricing" ] }, "PlatformOption": { "type": "object", "properties": { "screenshot": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CreateRun": { "type": "object", "properties": { "prompt": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "直接采集的问题，无需创建品牌或问题。" }, "platform": { "type": "string", "enum": [ "deepseek", "doubao", "kimi", "qwen", "yuanbao", "doubao_mobile", "yuanbao_mobile", "deepseek_mobile", "baiduai", "baidu_mobile", "qianwen_mobile", "antafu", "quark", "weibo_zhisou", "douyinai", "chatgpt", "googleai", "bingai_overviews", "xiaohongshu_mobile" ] }, "brandId": { "type": "string" }, "questionIds": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "platforms": { "type": "array", "items": { "type": "string", "enum": [ "deepseek", "doubao", "kimi", "qwen", "yuanbao", "doubao_mobile", "yuanbao_mobile", "deepseek_mobile", "baiduai", "baidu_mobile", "qianwen_mobile", "antafu", "quark", "weibo_zhisou", "douyinai", "chatgpt", "googleai", "bingai_overviews", "xiaohongshu_mobile" ] }, "minItems": 1 }, "collector": { "type": "string", "enum": [ "cloud" ], "default": "cloud", "description": "兼容旧版调用的可选通道标识，建议省略。系统统一使用云端采集，不继承本地浏览器配置，不自动降级。" }, "repeatCount": { "type": "integer", "minimum": 1, "maximum": 20, "default": 1 }, "intervalSeconds": { "type": "integer", "minimum": 0, "maximum": 3600, "default": 60 }, "platformOptions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlatformOption" }, "description": "键为本次已选择的平台 id；仅云端可用。" } }, "allOf": [ { "oneOf": [ { "required": [ "prompt" ], "not": { "anyOf": [ { "required": [ "brandId" ] }, { "required": [ "questionIds" ] } ] } }, { "required": [ "brandId", "questionIds" ], "not": { "required": [ "prompt" ] } } ] }, { "oneOf": [ { "required": [ "platform" ], "not": { "required": [ "platforms" ] } }, { "required": [ "platforms" ], "not": { "required": [ "platform" ] } } ] } ], "additionalProperties": false, "description": "直接传 prompt 和 platform（或 platforms）即可，无需品牌；旧 brandId/questionIds 模式仍支持。问题数 × 平台数 × repeatCount 不得超过 20。按客户有效销售价对每个问题/平台/采样扣款，截图按配置加价，并加收配置的 runs.create 接口费。上游成本不作为销售价；未配置销售价的平台返回 409。失败、取消不退款；幂等重试不重复扣款。" }, "AcceptedRun": { "type": "object", "properties": { "customerId": { "type": "string" }, "billing": { "type": "object", "properties": { "chargedCents": { "type": "integer" }, "balanceCents": { "type": "integer" } } }, "id": { "type": "string" }, "brandId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "partial_failed", "failed", "cancelled" ] }, "reused": { "type": "boolean" } }, "required": [ "id", "brandId", "status", "reused" ] }, "Citation": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string", "nullable": true } } }, "GoodsCard": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string", "nullable": true }, "thumbnail": { "type": "string", "nullable": true }, "price": { "type": "string" }, "priceUnit": { "type": "string" }, "mall": { "type": "string" }, "storeName": { "type": "string" }, "shopName": { "type": "string" }, "mallPlatform": { "type": "string" }, "mallProductId": { "type": "string" }, "skuId": { "type": "string" }, "position": { "type": "integer", "nullable": true } } }, "ProviderResult": { "type": "object", "properties": { "goods": { "type": "array", "items": { "$ref": "#/components/schemas/GoodsCard" }, "description": "回答中的商品卡；position 对应 [goods_card:x]。无商品时为空数组，旧记录可能缺省。商品标价不代表接口扣费。" }, "screenshotUrl": { "type": "string", "nullable": true }, "references": { "type": "array", "items": { "$ref": "#/components/schemas/Citation" } }, "sentiment": { "type": "string", "nullable": true, "enum": [ "positive", "negative", "neutral", null ] }, "mentionPosition": { "type": "integer", "nullable": true }, "competitorRankings": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rank": { "type": "integer", "nullable": true } } } } }, "nullable": true }, "Answer": { "type": "object", "properties": { "content": { "type": "string" }, "brandMentioned": { "type": "boolean" }, "mentionCount": { "type": "integer" }, "citations": { "type": "array", "items": { "$ref": "#/components/schemas/Citation" } }, "responseUrl": { "type": "string", "nullable": true }, "providerResult": { "$ref": "#/components/schemas/ProviderResult" } }, "required": [ "content", "citations" ], "nullable": true }, "Sample": { "type": "object", "properties": { "id": { "type": "string" }, "promptId": { "type": "string" }, "platformId": { "type": "string", "enum": [ "deepseek", "doubao", "kimi", "qwen", "yuanbao", "doubao_mobile", "yuanbao_mobile", "deepseek_mobile", "baiduai", "baidu_mobile", "qianwen_mobile", "antafu", "quark", "weibo_zhisou", "douyinai", "chatgpt", "googleai", "bingai_overviews", "xiaohongshu_mobile" ] }, "sampleIndex": { "type": "integer" }, "status": { "type": "string" }, "prompt": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "category": { "type": "string" } } }, "collector": { "type": "string" }, "monitoringOptions": { "type": "object", "properties": { "screenshot": { "type": "boolean" } } }, "quotedPriceCents": { "type": "integer", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "answer": { "$ref": "#/components/schemas/Answer" } } }, "Run": { "type": "object", "properties": { "id": { "type": "string" }, "brandId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "partial_failed", "failed", "cancelled" ] }, "repeatCount": { "type": "integer" }, "intervalSeconds": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "platformRuns": { "type": "array", "items": { "$ref": "#/components/schemas/Sample" } } }, "required": [ "id", "brandId", "status" ] }, "Metrics": { "type": "object", "properties": { "planned": { "type": "number", "nullable": true }, "valid": { "type": "number", "nullable": true }, "mentioned": { "type": "number", "nullable": true }, "failed": { "type": "number", "nullable": true }, "cancelled": { "type": "number", "nullable": true }, "pending": { "type": "number", "nullable": true }, "mentionRate": { "type": "number", "nullable": true }, "coverageRate": { "type": "number", "nullable": true }, "citationRate": { "type": "number", "nullable": true } } }, "Report": { "type": "object", "properties": { "schemaVersion": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "runId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "partial_failed", "failed", "cancelled" ] }, "brand": { "type": "object", "additionalProperties": true }, "summary": { "$ref": "#/components/schemas/Metrics" }, "groups": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "samples": { "type": "array", "items": { "$ref": "#/components/schemas/Sample" } }, "limitations": { "type": "string" } }, "required": [ "runId", "summary", "groups", "samples" ] }, "Overview": { "type": "object", "properties": { "brand": { "$ref": "#/components/schemas/Brand" }, "summary": { "type": "object", "additionalProperties": true }, "platforms": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "questions": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "trend": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "recentRuns": { "type": "array", "items": { "$ref": "#/components/schemas/Run" } } } }, "Sources": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "uniqueUrls": { "type": "integer" }, "citationOccurrences": { "type": "integer" }, "periodDays": { "type": "integer" } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "domain": { "type": "string" }, "platforms": { "type": "array", "items": { "type": "string" } }, "promptIds": { "type": "array", "items": { "type": "string" } }, "prompts": { "type": "array", "items": { "type": "string" } }, "citationCount": { "type": "integer" }, "citationOccurrences": { "type": "integer" }, "firstSeenAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" } } } } } } } } }