Agent API

查看端点

获取调用某个端点所需的一切:路径、查询和 body 输入的 JSON Schema、示例输入、价格和响应 schema。免费,无需 key。

POST/v1/inspect

也可以用 GET /v1/inspect?provider=…&endpoint=…&method=…。

鉴权

无需鉴权。

Body

providerstring必填

API slug,来自 /v1/discover。

endpointstring必填

路径模板,如 /users/{id}。也可以传具体路径(/users/42)去匹配模板,或用 "GET /path" 同时指定方法。

methodstring

HTTP 方法。可省略;同一路径有多个方法时优先 GET。

请求示例

bash

curl -X POST https://gw.pikeway.ai/v1/inspect \
  -H "Content-Type: application/json" \
  -d '{"provider": "birdeye", "endpoint": "/defi/price"}'

响应

200 OK

{
  "provider": "birdeye",
  "providerName": "Birdeye",
  "endpoint": "/defi/price",
  "method": "GET",
  "name": "Token price",
  "description": "Current price of a token by mint address",
  "summary": "Solana and multi-chain token data",
  "category": "Crypto",
  "tags": ["solana", "price", "defi"],
  "input": {
    "queryParams": {
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "description": "Token mint address",
          "examples": ["So11111111111111111111111111111111111111112"]
        }
      },
      "required": ["address"]
    }
  },
  "exampleInput": {
    "queryParams": { "address": "So11111111111111111111111111111111111111112" }
  },
  "price": {
    "type": "PER_CALL",
    "amount": { "value": 0.001, "currency": "USD" },
    "notes": ["charged only when the upstream call succeeds (HTTP 2xx)"]
  },
  "notes": [],
  "hints": {
    "inspect": "curl -s -X POST https://gw.pikeway.ai/v1/inspect …",
    "run": "curl -s -X POST https://gw.pikeway.ai/v1/run -H 'Authorization: Bearer $PIKEWAY_API_KEY' … -d '{\"endpoint\":\"/defi/price\",\"input\":{…},\"method\":\"GET\",\"provider\":\"birdeye\"}'",
    "docs": "…/apis/birdeye?ep=GET+%2Fdefi%2Fprice"
  },
  "responses": { "200": { "…": "OpenAPI-style response objects, when published" } },
  "docUrl": "…/apis/birdeye?ep=GET+%2Fdefi%2Fprice"
}

字段

input.pathParamsJSON Schema

路径含占位符时出现;所有占位符都必填。

input.queryParamsJSON Schema

查询参数,必填项列在 required 中。

input.body · input.bodyTypeJSON Schema · "json"

请求 body 的 schema,非 GET 且提供方发布了 schema 时出现。

exampleInputobject

可直接用作 /v1/run 的 input,由参数示例/默认值生成。没有时省略。

priceobject

结构与 /v1/discover 相同。

notesstring[]

例如该端点由 Pikeway 自营,或按 token 计费、建议改用 /ai/v1。

responsesobject

端点发布的响应定义(状态码 → schema/示例),有时才返回。

hints · docUrlobject · string

可直接执行的 curl 命令(run 命令已带 exampleInput)和市场文档链接。

错误

400 provider and endpoint are required (see POST /v1/discover) · body must be JSON
404 unknown provider: …
404 unknown endpoint … on …,并在 available 中列出该提供方最多 30 个端点:
405 use POST

Agent API 只能看到已上线公开 API 的公开 HTTP 端点(目录约每 30 秒刷新)。私有 API、隐藏端点和 GraphQL/gRPC 方法不在其中,请通过 /gw 调用。

404 Not Found

{
  "code": 404,
  "message": "unknown endpoint /price on birdeye",
  "available": ["GET /defi/history_price", "GET /defi/price", "GET /defi/token_overview"]
}