指南

自带 key

有些 API(搜索、抓取、爬虫类服务)使用你在提供方自己的账户。把提供方的 key 在 Pikeway 保存一次,就能像调用其他 API 一样调用它们,使用同一把 Pikeway key、MCP、CLI 和调用日志。费用由提供方直接向你收取,Pikeway 对这些调用不收费。

支持的连接器

Exa、Firecrawl、Serper 和 Apify。

设置

1

从提供方获取 key

在提供方注册并在其控制台创建 API key。控制台 → Connections 里为每个提供方都附了对应页面的链接。

2

在控制台 → Connections 保存

把 key 粘贴到控制台 → Connections。它会加密存储,只会发给对应的提供方。同一个 API 可以再加几把 key(轮流使用,各自有预算),随时替换或删除,还能看到每把 key 今天和本月的调用。

3

用 Pikeway key 调用

调用方式完全不变。网关会在转发前换上你的提供方 key。

bash

curl -i -X POST https://gw.pikeway.ai/gw/exa/search \
  -H "Authorization: Bearer $PIKEWAY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "x402 payment protocol"}'

# X-Pikeway-Byok: 1      ← your own Exa key was used
# X-Pikeway-Cost: 0      ← Pikeway charged nothing; Exa bills your Exa account

这些调用如何处理

计费:在 Pikeway 上费用为 0,用量和费用记在你在提供方的账户上。
日志:每次调用照常出现在调用日志和用量里,响应带有 X-Pikeway-Byok: 1 标记。
缓存:响应从不缓存或共享,因为它们属于你自己的提供方账户。
Pikeway key 上的限制(IP 白名单、站点、限流)依然生效。

没有保存 key 时

如果连接器要求使用你自己的 key(目前全部如此),没保存就调用会返回 403,并附上获取 key 的链接。标为可选的连接器则会改用 Pikeway 自己的接入,照常按次计费。

403

HTTP/1.1 403 Forbidden
{
  "error": "add your Exa API key in Console → Connections to call this API (it's billed by Exa, not Pikeway)",
  "statusCode": 403,
  "byok": true,
  "provider": "Exa",
  "signupUrl": "https://dashboard.exa.ai/api-keys",
  "keyHint": "Exa dashboard → API Keys"
}

403 响应字段

byoktrue

告诉 agent 这是缺少 key,而不是权限问题。

signupUrlstring

在提供方创建 key 的地址。

keyHintstring

在提供方控制台中找到 key 的位置。