代理支付 API

介绍

代理支付 API 允许 AI 代理代表用户自主管理和购买 API 积分。这实现了无人值守的工作流程,代理可以查看剩余积分余额、审核消费限额,并通过用户保存的 Stripe 付款方式充值,所有操作均无需人工干预。

所有三个端点都托管在 payments.builtwith.com 并使用您的 BuiltWith API 密钥进行身份验证。

代理要使用这些端点,用户必须启用代理 API 计费并配置消费限额。 https://payments.builtwith.com/agent-payment-api-config.
验证

请使用以下任一方法传递代理 API 密钥。如果同时提供了这两种方法,则 KEY 查询参数优先。

授权标头(推荐)

Authorization: Bearer 00000000-0000-0000-0000-000000000000

查询参数(备用)

?KEY=00000000-0000-0000-0000-000000000000

缺少、无效或禁用密钥的请求将返回 HTTP 401 错误。计费已暂停的帐户将返回 HTTP 403 错误。

🤖 AI代理提示
Reference https://api.builtwith.com/llms.txt and
https://raw.githubusercontent.com/builtwith/builtwith-ai-sdk/refs/heads/main/README.md
Add BuiltWith Agent Payment API support to my app. Check the current API credit balance,
and if below 1000 credits, purchase 2000 more using the Agent Payment API.
GET /v1/billing/api-discovery — 贷方余额

返回账户当前的 API 信用余额。

要求

GET https://payments.builtwith.com/v1/billing/api-discovery?KEY=00000000-0000-0000-0000-000000000000

响应字段
场地类型描述
credits_totalnumber账户累计获得的信用额度。
credits_usednumber迄今为止,API 调用消耗的积分数量。
credits_availablenumber剩余可用积分(总积分减去已用积分)。这是代理在发起 API 调用之前应该检查的内容。
示例回答
{
  "credits_total": 10000,
  "credits_used": 1234,
  "credits_available": 8766
}
GET /v1/billing/api-configuration — 消费限额

返回已配置的消费限额以及已使用的月度限额。代理商应在尝试购买前检查此信息,以避免请求被拒绝。

要求

GET https://payments.builtwith.com/v1/billing/api-configuration?KEY=00000000-0000-0000-0000-000000000000

响应字段
场地类型描述
max_per_purchasenumber代理人单笔交易可购买的最大信用额度。
max_monthlynumber代理人在当月可购买的最大信用额度。
monthly_purchasednumber该代理商本月已购买的积分。
monthly_remainingnumber本月在达到月度限额之前还能购买多少积分?
cost_per_2000_credits_usdnumber最低2000积分购买的美元价格。请使用此价格估算计划购买的成本。
示例回答
{
  "max_per_purchase": 5000,
  "max_monthly": 20000,
  "monthly_purchased": 5000,
  "monthly_remaining": 15000,
  "cost_per_2000_credits_usd": 99.00
}
POST /v1/billing/api-purchase — 购买积分

系统会从用户保存的 Stripe 付款方式中扣款,并立即将款项记入账户。此次购买受代理 API 计费配置中设置的单次购买和每月限额的限制。

要求

POST https://payments.builtwith.com/v1/billing/api-purchase

请将代理 API 密钥作为附件发送。 Authorization: Bearer 标题或作为 ?KEY= 查询参数。请求体必须为 JSON 格式。

请求正文
场地类型必需的描述
creditsnumber是的可购买的积分数量。最少 2,000 积分。不得超过 max_per_purchase 或剩余的月度津贴。
成功响应(HTTP 200)
场地类型描述
successbooleantrue
credits_purchasednumber账户已添加积分。
cost_usdnumber以美元计价的金额。
payment_idstringStripe PaymentIntent ID 用于对账。
credits_availablenumber购买后更新可用信用余额。
请求正文示例
{ "credits": 2000 }
成功回应示例
{
  "success": true,
  "credits_purchased": 2000,
  "cost_usd": 99.00,
  "payment_id": "pi_3abc123xyz",
  "credits_available": 10766
}
错误响应
HTTP意义
400验证失败 - 积分低于 2,000,超过单次购买限额,或超过每月限额。
401代理 API 密钥缺失或无效。
402Stripe支付失败或账户中没有可用的支付方式。
403账户计费已暂停。
405方法不允许 - 端点需要 POST 请求。
特殊域名

我们维护两个列表,供您在查找域名时使用。“忽略”列表和“BuiltWith 后缀”列表。

忽略列表
T这是我们内部不予索引的域名列表。这些域名要么被屏蔽,要么包含太多误导性技术,要么包含太多包含用户生成内容的子域名。

BuiltWith 后缀列表
这是基于 公共后缀列表 但对于拥有子域名的公司来说,还包括许多额外的条目,这些子域名应被视为顶级域名。 此列表为我们提供了内部网站的更好可见性,例如,它将 northernbeaches.nsw.gov.au 置于 nsw.gov.au 之上。

忽略域 (XML, JSON or TXT)
https://api.builtwith.com/ignoresv1/api.json
后缀域 (XML, JSON or TXT)
https://api.builtwith.com/suffixv1/api.json
错误代码

请注意,这种格式的错误消息无法保证,您的实现也应该将非 200 响应代码视为错误。 如果错误与服务器相关,则 Lookup 属性将为 null(json)或未提供(xml)。 查看所有潜在的格式正确的错误代码.

使用条款

我们的 标准条款 涵盖我们所有 API 的使用。

一般来说,您可以使用 API 以多种方式增强您的产品。唯一的限制是您不能按原样转售数据,也不能向builtwith.com及其相关服务提供重复的功能。