Agent API

搜索端点

用自然语言搜索整个市场,返回排好序的端点,附价格、可靠性和可直接执行的下一步。免费,无需 key。

POST/v1/discover

也支持 GET /v1/discover?query=…(q 也可以),字段与 body 相同,作为查询参数传入。

鉴权

无需鉴权。搜索免费,不需要 key。

Body

querystring必填

用自然语言描述需求(1–1000 字符),中英文均可,如“solana 上的代币价格”。

limitinteger

最多返回条数。默认 5,最大 40。

minScorenumber

丢弃分数低于该值的结果。默认 0.3。

categorystring

只返回该分类的 API(不区分大小写),如 Crypto。

providerstring

只返回该 API slug 的端点。

maxPricenumber

只返回单次价格不超过该值(美元)的端点。

请求示例

bash

curl -X POST https://gw.pikeway.ai/v1/discover \
  -H "Content-Type: application/json" \
  -d '{"query": "token price on solana", "limit": 3}'

响应

200 OK

{
  "results": [
    {
      "provider": "birdeye",
      "providerName": "Birdeye",
      "endpoint": "/defi/price",
      "method": "GET",
      "name": "Token price",
      "description": "Current price of a token by mint address",
      "category": "Crypto",
      "tags": ["solana", "price", "defi"],
      "score": 0.874,
      "scoreBreakdown": {
        "relevance": 0.912,
        "reliability": 0.991,
        "price": 0.667,
        "matchedTerms": ["token", "price", "solana"],
        "popularity": 0.41,
        "semantic": 0.83
      },
      "price": {
        "type": "PER_CALL",
        "amount": { "value": 0.001, "currency": "USD" },
        "notes": ["charged only when the upstream call succeeds (HTTP 2xx)"]
      },
      "stats": { "successRate30d": 0.991, "p50Ms": 182 },
      "hints": {
        "inspect": "curl -s -X POST https://gw.pikeway.ai/v1/inspect -H 'Content-Type: application/json' -d '{\"endpoint\":\"/defi/price\",\"method\":\"GET\",\"provider\":\"birdeye\"}'",
        "run": "curl -s -X POST https://gw.pikeway.ai/v1/run -H 'Authorization: Bearer $PIKEWAY_API_KEY' -H 'Content-Type: application/json' -d '{…}'",
        "docs": "…/apis/birdeye?ep=GET+%2Fdefi%2Fprice"
      }
    }
  ],
  "query": "token price on solana",
  "count": 1
}

结果字段

provider · endpoint · methodstring

把它们传给 /v1/inspect 和 /v1/run。provider 是 API slug,endpoint 是路径模板。

scorenumber 0–1

综合排序分:以相关度为主,可靠性、价格和真实调用量在相关度接近时起作用。

scoreBreakdownobject

relevance(文本匹配,有向量时与 semantic 语义相似度混合)、reliability(近 30 天成功率,未知时为 0.9)、price(越便宜越高)、popularity(近 30 天成功调用量)、matchedTerms。

priceobject

type 为 PER_CALL、PER_TOKEN 或 BYOK;amount 为每次调用的美元价格。免费端点带 free: true。自带 key 的 API 额外带 byok、notes 和 signupUrl。

statsobject

流量足够时给出 successRate30d 和 p50Ms。

hintsobject

可直接执行的 inspect 和 run 的 curl 命令,以及端点文档页链接。

results 为空表示没有结果超过 minScore;换个说法或调低它。

错误

400 query is required (1-1000 characters)
400 body must be JSON: {"query": "..."}
405 use POST (GET 和 POST 以外的方法)