Agent API

Inspect an endpoint

Get everything needed to call one endpoint: JSON Schemas for its path, query and body inputs, an example input, the price, and the response schema. Free, no key needed.

POST/v1/inspect

Also available as GET /v1/inspect?provider=…&endpoint=…&method=….

Authentication

None.

Body

providerstringrequired

API slug, from /v1/discover.

endpointstringrequired

Path template such as /users/{id}. A concrete path (/users/42) is matched against the templates, and "GET /path" sets the method inline.

methodstring

HTTP method. Optional; when a path has several methods, GET is preferred.

Request

bash

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

Response

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"
}

Fields

input.pathParamsJSON Schema

Present when the path has placeholders; all of them are required.

input.queryParamsJSON Schema

Query parameters, with required ones listed in required.

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

Request body schema, for non-GET endpoints that publish one.

exampleInputobject

Ready-to-use input for /v1/run, built from parameter examples/defaults. Omitted when there are none.

priceobject

Same shape as in /v1/discover.

notesstring[]

E.g. the endpoint is operated by Pikeway itself, or is token-billed and better called via /ai/v1.

responsesobject

The endpoint's published response definitions (status → schema/example), when available.

hints · docUrlobject · string

Ready-to-run curl commands (the run hint includes exampleInput) and the marketplace docs link.

Errors

400 provider and endpoint are required (see POST /v1/discover) · body must be JSON
404 unknown provider: …
404 unknown endpoint … on …, with available listing up to 30 of the provider's endpoints:
405 use POST

The Agent API sees only public HTTP endpoints of live, public APIs (the catalog refreshes about every 30 seconds). Private APIs, hidden endpoints and GraphQL/gRPC methods are not listed; call those through /gw.

404 Not Found

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