指南

Key、余额与计费

一份预付余额支付所有 API。每次调用价格固定,只有成功才扣费,每个响应都会告诉你花了多少钱。

钱是怎么流动的

1

给余额充值

在 控制台 → 账单 用银行卡或 USDC 充值,最低 $1。

2

创建 API key

在 控制台 → API Key 创建一把 key。它以 pk- 开头,明文只显示一次,请妥善保存。

3

调用任意 API

转发前,网关先从余额里冻结本次价格。上游成功则转为扣费,否则退回冻结,你一分钱不花。

API key

以 Authorization: Bearer pk-…(或 X-API-Key: pk-…)发送 key。同一把 key 可用于所有 API、AI 网关、MCP、CLI 和 SDK。key 数量不限,比如每个 agent 或环境一把,并在 控制台 → API Key 里分别设置限制。

单个 key 的设置
额度USD
这把 key 的消费上限。达到后调用返回 402 api key spend limit reached,直到你调高或重置额度。用它防止某个失控的 agent 循环把余额花光。
IP 白名单IP / CIDR
最多 100 个 IP 或 CIDR 网段(如 203.0.113.7、10.0.0.0/8)。其他地址的请求返回 403 client IP not allowed for this API key。留空表示不限制。
站点hostnames
把 key 限制在你自己域名的网页上使用,即浏览器 key。见 浏览器 key。
轮换
生成一把设置和已用额度都相同的新 key。旧 key 在宽限期内继续可用(默认 24 小时,最长 7 天),方便你无停机地把新 key 换进 agent 和 CI。
删除
删除 key 后立即失效,之后的调用返回 401 invalid or revoked API key。
不要把没有限制的 key 放进网页或移动应用。key 应留在服务端,或者使用限制了站点的浏览器 key。

余额与充值

  • 银行卡:通过 Stripe Checkout 付款,付款完成后余额立即更新。也可以开启自动充值,余额不足时自动补充。
  • USDC:向订单显示的充值地址转入 USDC(默认 Base 链)。每张订单有唯一的精确金额,24 小时内有效,系统据此把到账匹配到你的账户。

余额显示在控制台顶部。agent 也可以用同一把 key 读取余额和流水:

bash
curl https://gw.pikeway.ai/v1/wallet/balance -H "Authorization: Bearer $PIKEWAY_KEY"
# {"balance":{"value":12.48,"currency":"USD"}, …}

curl https://gw.pikeway.ai/v1/wallet/activities -H "Authorization: Bearer $PIKEWAY_KEY"   # charges, refunds, top-ups

余额不够支付本次价格时,网关直接返回 402 insufficient balance,不会调用上游。

按次定价

每个端点都有固定的美元价格,由提供者设定,显示在它的市场页面上,也可以通过 /v1/inspect 查询。请求里的任何内容都不会改变价格。AI 模型例外,按 token 计费,见 AI 网关。WebSocket 流有单独的建连、按消息和按分钟价格,见 WebSocket。

部分 API 提供阶梯折扣:当月你对该 API 的调用量超过门槛后,后续调用自动打折,折扣写在 X-Pikeway-Volume-Discount 响应头里。

只为成功的调用付费

只有上游返回 2xx 时才扣费。以下情况不收费:

  • 上游返回错误状态(4xx、5xx)或重定向(3xx),或连接不上(502);
  • 上游返回 200 但响应体表示失败(带业务错误码的 API、只有 errors 的 GraphQL 响应、grpc-status 非 0 的 gRPC)。这类响应带有 X-Pikeway-Upstream-Error;
  • 请求在网关层就被拒绝(key 无效、缺少参数、限流、余额不足);
  • 扣费无法入账。此时网关返回 503,也不会交付响应。

从响应里读取费用

每个网关响应都带 X-Pikeway-Cost(本次扣费的美元金额,未扣费时为 0)和 X-Pikeway-Call-Id。两者都通过 CORS 暴露给浏览器。

bash
curl -i "https://gw.pikeway.ai/gw/dexscreener/latest/dex/search?q=WBTC" \
  -H "Authorization: Bearer $PIKEWAY_KEY"

# HTTP/1.1 200 OK
# X-Pikeway-Call-Id: 0192f3c1-…
# X-Pikeway-Cost: 0.0003
计费相关响应头
X-Pikeway-CostUSD
本次调用扣费金额。
X-Pikeway-Call-Idstring
唯一 id,与调用日志对应,发起争议时用它。
X-Pikeway-Tokensin+out
AI 调用:计费的输入和输出 token 数。
X-Pikeway-Planstring
覆盖本次调用的订阅套餐名称。
X-Pikeway-Quota-Remainingint
当前套餐周期内剩余的包含调用次数。
X-Pikeway-Volume-Discount%
本次调用享受的阶梯折扣。

用 Idempotency-Key 安全重试

对不能执行两次的调用,带上 Idempotency-Key。同一把 API key 下,重复的 Idempotency-Key 不会再次转发或扣费,网关会返回 409。

bash
curl -X POST "https://gw.pikeway.ai/gw/<slug>/<path>" \
  -H "Authorization: Bearer $PIKEWAY_KEY" \
  -H "Idempotency-Key: order-7f3a" \
  -d '{ … }'
# Retrying with the same Idempotency-Key never forwards or charges twice (409 on a duplicate).

订阅套餐

部分提供者在按次计费之外(或代替按次计费)出售套餐。在 API 的市场页面订阅,在 控制台 → 订阅 管理。套餐生效期间:

  • 包含额度内的调用免费,只有成功的调用才占用额度;
  • 额度用完后,根据提供者的设置,要么拒绝后续调用(429 plan quota exhausted),要么按超额价计费;
  • 使用套餐自己的限流规则,而不是 API 的默认限流。

只卖套餐的 API,对没有有效套餐的 key 返回 403。

争议

某次调用扣了费却没有拿到 API 承诺的结果?在扣费后 14 天内到 控制台 → 争议 发起争议,填写调用 id(来自 X-Pikeway-Call-Id 或调用日志)和简短理由。

  • 每笔扣费中提供者的收入在争议期内处于冻结状态,争议未结期间也不会结算给提供者。
  • Pikeway 审核后,要么全额或部分退款到你的余额,要么驳回。状态显示为 OPEN、REFUNDED 或 REJECTED。
  • 每笔扣费只能发起一次争议。