Mit der Agent Payment API von BuiltWith

Einführung

Die Agent Payment API ermöglicht es einem KI-Agenten, API-Guthaben im Namen eines Nutzers autonom zu verwalten und zu erwerben. Dies ermöglicht unbeaufsichtigte Arbeitsabläufe, in denen der Agent seinen verbleibenden Guthabenstand prüfen, Ausgabenlimits einsehen und Guthaben über die gespeicherte Stripe-Zahlungsmethode des Nutzers aufladen kann – alles ohne menschliches Eingreifen.

Alle drei Endpunkte werden gehostet auf payments.builtwith.com und authentifizieren Sie sich mit Ihrem BuiltWith-API-Schlüssel.

Bevor ein Agent diese Endpunkte nutzen kann, muss der Benutzer die Agent-API-Abrechnung aktivieren und Ausgabenlimits konfigurieren unter https://payments.builtwith.com/agent-payment-api-config.

Authentifizierung

Übergeben Sie den Agent-API-Schlüssel mit einer der beiden unten beschriebenen Methoden. Der Abfrageparameter KEY hat Vorrang, falls beide angegeben werden.

Autorisierungsheader (empfohlen)

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

Abfrageparameter (Fallback)

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

Anfragen mit einem fehlenden, ungültigen oder deaktivierten Schlüssel geben den HTTP-Statuscode 401 zurück. Konten, deren Abrechnung gesperrt ist, geben den HTTP-Statuscode 403 zurück.

🤖 KI-Agenten-Aufforderung

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 — Guthaben

Gibt den aktuellen API-Guthabenstand des Kontos zurück.

Anfrage

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

Antwortfelder

Feld	Typ	Beschreibung
`credits_total`	`number`	Die dem Konto jemals zugewiesenen Gesamtguthaben.
`credits_used`	`number`	Bisher durch API-Aufrufe verbrauchte Guthaben.
`credits_available`	`number`	Verbleibendes nutzbares Guthaben (Gesamtguthaben minus verbrauchtes Guthaben). Dies sollte der Agent vor API-Aufrufen überprüfen.

Beispielantwort

{
  "credits_total": 10000,
  "credits_used": 1234,
  "credits_available": 8766
}

GET /v1/billing/api-configuration — Ausgabenlimits

Gibt die konfigurierten Ausgabenlimits und den bereits verbrauchten Anteil des monatlichen Budgets zurück. Der Agent sollte dies vor jedem Kaufversuch prüfen, um abgelehnte Anfragen zu vermeiden.

Anfrage

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

Antwortfelder

Feld	Typ	Beschreibung
`max_per_purchase`	`number`	Maximale Kredite, die der Agent in einer einzelnen Transaktion erwerben darf.
`max_monthly`	`number`	Maximale Gutschriften, die der Agent im laufenden Kalendermonat erwerben kann.
`monthly_purchased`	`number`	Guthaben, die der Agent in diesem Kalendermonat bereits erworben hat.
`monthly_remaining`	`number`	Wie viele Credits können diesen Monat noch erworben werden, bevor das monatliche Limit erreicht ist?
`cost_per_2000_credits_usd`	`number`	Kosten in US-Dollar für einen Mindestkauf von 2.000 Credits. Nutzen Sie diese Angabe, um die Kosten eines geplanten Kaufs abzuschätzen.

Beispielantwort

{
  "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 — Credits kaufen

Die hinterlegte Stripe-Zahlungsmethode des Nutzers wird belastet und das Konto sofort gutgeschrieben. Der Kauf unterliegt den in der Agent-API-Abrechnungskonfiguration festgelegten Kauf- und Monatslimits.

Anfrage

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

Senden Sie den Agent-API-Schlüssel als Authorization: Bearer Kopfzeile oder als ?KEY= Abfrageparameter. Der Anfragetext muss im JSON-Format vorliegen.

Anfragetext

Feld	Typ	Erforderlich	Beschreibung
`credits`	`number`	Ja	Anzahl der zu erwerbenden Credits. Mindestens 2.000. Darf nicht überschreiten `max_per_purchase` oder dem verbleibenden monatlichen Taschengeld.

Erfolgsmeldung (HTTP 200)

Feld	Typ	Beschreibung
`success`	`boolean`	`true`
`credits_purchased`	`number`	Dem Konto wurden Guthaben hinzugefügt.
`cost_usd`	`number`	Der berechnete Betrag ist in US-Dollar angegeben.
`payment_id`	`string`	Stripe PaymentIntent-ID für den Abgleich.
`credits_available`	`number`	Aktualisierter verfügbarer Kreditbetrag nach dem Kauf.

Beispielhafter Anfragetext

{ "credits": 2000 }

Beispiel einer erfolgreichen Antwort

{
  "success": true,
  "credits_purchased": 2000,
  "cost_usd": 99.00,
  "payment_id": "pi_3abc123xyz",
  "credits_available": 10766
}

Fehlermeldungen

HTTP	Bedeutung
400	Validierungsfehler – Guthaben unter 2.000, Überschreitung des Limits pro Kauf oder Überschreitung des monatlichen Limits.
401	Fehlender oder ungültiger Agent-API-Schlüssel.
402	Die Zahlung mit Stripe ist fehlgeschlagen oder es ist keine gültige Zahlungsmethode hinterlegt.
403	Die Kontoabrechnung wurde ausgesetzt.
405	Methode nicht zulässig - Endpunkt erfordert POST.

Spezielle Domänen

Wir führen für Sie zwei Listen, die Sie bei der Suche nach Domänen verwenden können: Ignorierlisten und BuiltWith-Suffixlisten.

Ignorierliste
TDies ist unsere eigene interne Liste von Domänen, die wir nicht indizieren. Sie sind entweder blockiert, enthalten zu viele irreführende Technologien oder zu viele Subdomänen mit benutzergenerierten Inhalten.

BuiltWith Suffixliste
Dies basiert auf der Öffentliche Suffixliste enthält aber viele zusätzliche Einträge für Unternehmen mit Subdomänen, die als Top-Level-Domänen betrachtet werden sollten. Diese Liste bietet uns eine bessere Sichtbarkeit für interne Websites, beispielsweise bringt sie northernbeaches.nsw.gov.au auf die oberste Ebene über nsw.gov.au.

Domänen ignorieren (XML, JSON or TXT)

https://api.builtwith.com/ignoresv1/api.json

Suffixdomänen (XML, JSON or TXT)

https://api.builtwith.com/suffixv1/api.json

Fehlercodes

Beachten Sie, dass Fehlermeldungen in diesem Format nicht garantiert werden können. Ihre Implementierung sollte auch Antwortcodes ungleich 200 als Fehler betrachten. Die Lookup-Eigenschaft ist null (JSON) oder wird nicht bereitgestellt (XML), wenn der Fehler serverbezogen ist. Alle potenziellen wohlgeformten Fehlercodes anzeigen.

Nutzungsbedingungen

Unser Allgemeine Geschäftsbedingungen decken die Verwendung aller unserer APIs ab.

Sie können die API grundsätzlich nutzen, um Ihr Produkt auf vielfältige Weise zu verbessern. Die einzige Einschränkung besteht darin, dass Sie die Daten nicht unverändert weiterverkaufen oder doppelte Funktionen für builtwith.com und die zugehörigen Dienste bereitstellen dürfen.