エージェント決済APIを搭載

ログイン サインアップ
導入

エージェント決済APIを使用すると、AIエージェントがユーザーに代わってAPIクレジットを自律的に管理および購入できます。これにより、エージェントが残りのクレジット残高を確認したり、支出限度額を確認したり、ユーザーが保存したStripe決済方法を使用してクレジットを補充したりといった作業を、人間の介入なしに自動で行うことができます。

3つのエンドポイントはすべて、 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代理店が1回の取引で購入できる最大クレジット数。
max_monthlynumber代理店が当暦月中に購入できる最大クレジット数。
monthly_purchasednumber代理店が今月既に購入したクレジット。
monthly_remainingnumber今月、月間上限に達するまでにあと何クレジット購入できますか？
cost_per_2000_credits_usdnumber最低購入額2,000クレジットの米ドル建て価格です。この価格を参考に、購入予定額の概算を行ってください。
回答例
{
  "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_idstring照合のためのStripe 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メソッドを必要とします。
特別ドメイン

ドメイン検索の際に使用する2つのリストを用意しています。無視リストとBuiltWithサフィックスリストです。

無視リスト
Tこれは、インデックスに登録しないドメインの社内リストです。これらのドメインはブロックされているか、誤解を招く技術が多すぎるか、ユーザー生成コンテンツを含むサブドメインが多すぎるため、インデックスに登録しません。

BuiltWith サフィックスリスト
これは、 パブリックサフィックスリスト ただし、トップレベルドメインと見なされるサブドメインを持つ企業の追加エントリが多数含まれています。 このリストにより、内部 Web サイトの可視性が向上します。たとえば、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 および関連サービスに重複した機能を提供したりできないことです。