跳转到主要内容
POST
检查接口
按 input_schema 构造请求,并在运行前检查价格。将 endpoint_version 用于 Run;版本不会锁定价格。同步接口的客户端超时应高于 timeout_ms。

请求体

application/json
provider
string
必填
Pattern: ^[a-z0-9][a-z0-9-]*$
endpoint
string
必填
Pattern: ^\/.+$
endpoint_version
integer | null

选择受支持的接口版本,包括旧版本;省略则使用默认版本。版本不可用或已停用时返回 409。

必填范围: x > 0
task_id
string | null

本次检查所属 Task,来自数据源搜索响应,接受任意稳定字符串。

metadata

可选追踪字段,随 Run 返回,也可用于筛选。不会发送给数据提供商,也不影响路由、价格或幂等。

  • 最多 20 个键:小写字母、数字和下划线,以字母开头,最长 40 个字符。
  • 值:长度为 1–500 的字符串。
  • user_id:终端用户的不透明 ID,不得使用邮箱或姓名。

无效条目整体丢弃,不截断。请求继续执行,Run 返回实际保存的字段。

响应

成功

provider
string
必填
Pattern: ^[a-z0-9][a-z0-9-]*$
provider_label
string
必填

数据提供商品牌名称,仅用于展示,例如 provider 为 pdl 时显示 People Data Labs。身份仍由 provider 标识,运行和检查时使用 provider,不传回此展示名称。

endpoint
string
必填
Pattern: ^\/.+$
endpoint_version
integer
必填

受支持的接口版本。兼容更新保持此版本号。

name
string
必填
description
string
必填
tags
string[]
必填
price
object
必填

当前价格及计费规则。价格可在不更改接口版本的情况下变化。新 Run 使用受理时价格,已受理 Run 保留该价格。

run_mode
enum<string>
必填
可用选项:
sync,
async
method
enum<string>
必填
可用选项:
GET,
POST,
PUT,
PATCH,
DELETE,
HEAD
input_schema
object
必填

Run 输入的数据提供商原生 JSON Schema。

output_schema
object | null
必填

成功输出的 JSON Schema。没有可靠 Schema 时为 null,示例响应不构成 Schema。

output_schema_source
enum<string> | null
必填

输出 Schema 的定义方:数据提供商或 Glasser。output_schema 为 null 时,此值也为 null。

可用选项:
provider,
glasser
sample_input
object
必填

示例输入。根据请求调整,并按 input_schema 校验。

doc_url
string | null
必填

数据提供商文档链接,如有。

timeout_ms
integer | null

同步接口从 Run 请求到终态响应的最长毫秒数。HTTP 客户端超时应高于此值。

必填范围: x > 0
client
object