API de pago de agentes de BuiltWith

Introducción

La API de pago para agentes permite que un agente de IA gestione y compre créditos de API de forma autónoma en nombre de un usuario. Esto posibilita flujos de trabajo automatizados en los que el agente puede consultar su saldo de crédito restante, revisar los límites de gasto y recargar créditos mediante el método de pago Stripe guardado por el usuario, todo ello sin intervención humana.

Los tres puntos finales están alojados en payments.builtwith.com y autentícate con tu clave API de BuiltWith.

Antes de que un agente pueda utilizar estos puntos finales, el usuario debe habilitar la facturación de la API del agente y configurar los límites de gasto en https://payments.builtwith.com/agent-payment-api-config.
Autenticación

Pase la clave API del agente utilizando cualquiera de los métodos que se describen a continuación. El parámetro de consulta KEY tiene prioridad si se proporcionan ambos.

Encabezado de autorización (recomendado)

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

Parámetro de consulta (alternativa)

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

Las solicitudes con una clave faltante, inválida o deshabilitada devuelven un error HTTP 401. Las cuentas con facturación suspendida devuelven un error HTTP 403.

🤖 Mensaje del agente de IA
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 — Saldo acreedor

Devuelve el saldo de crédito API actual de la cuenta.

Pedido

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

Campos de respuesta
CampoTipoDescripción
credits_totalnumberCréditos totales asignados a la cuenta.
credits_usednumberCréditos consumidos por las llamadas a la API hasta la fecha.
credits_availablenumberCréditos utilizables restantes (total menos créditos utilizados). Esto es lo que el agente debe verificar antes de realizar llamadas a la API.
Ejemplo de respuesta
{
  "credits_total": 10000,
  "credits_used": 1234,
  "credits_available": 8766
}
GET /v1/billing/api-configuration — Límites de gasto

Devuelve los límites de gasto configurados y el importe del presupuesto mensual ya utilizado. El agente debe comprobar esta información antes de intentar realizar una compra para evitar que se rechacen las solicitudes.

Pedido

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

Campos de respuesta
CampoTipoDescripción
max_per_purchasenumberCréditos máximos que el agente puede comprar en una sola transacción.
max_monthlynumberCantidad máxima de créditos que el agente puede adquirir durante el mes calendario actual.
monthly_purchasednumberCréditos ya adquiridos por el agente durante este mes calendario.
monthly_remainingnumber¿Cuántos créditos más se pueden comprar este mes antes de alcanzar el límite mensual?
cost_per_2000_credits_usdnumberCosto en USD para la compra mínima de 2000 créditos. Utilice este valor para estimar el costo de una compra planificada.
Ejemplo de respuesta
{
  "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 — Comprar créditos

Se realiza el cargo al método de pago Stripe guardado por el usuario y se abona inmediatamente en la cuenta. La compra está sujeta a los límites mensuales y por compra establecidos en la configuración de facturación de la API del agente.

Pedido

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

Envíe la clave API del agente como Authorization: Bearer encabezado o como un ?KEY= Parámetro de consulta. El cuerpo de la solicitud debe ser JSON.

Cuerpo de la solicitud
CampoTipoRequeridoDescripción
creditsnumberNúmero de créditos a comprar. Mínimo 2000. No debe exceder max_per_purchase o la asignación mensual restante.
Respuesta exitosa (HTTP 200)
CampoTipoDescripción
successbooleantrue
credits_purchasednumberCréditos añadidos a la cuenta.
cost_usdnumberImporte cobrado en USD.
payment_idstringID de Stripe PaymentIntent para la conciliación.
credits_availablenumberSaldo de crédito disponible actualizado después de la compra.
Ejemplo de cuerpo de la solicitud
{ "credits": 2000 }
Ejemplo de respuesta exitosa
{
  "success": true,
  "credits_purchased": 2000,
  "cost_usd": 99.00,
  "payment_id": "pi_3abc123xyz",
  "credits_available": 10766
}
Respuestas de error
HTTPSignificado
400Fallo de validación: los créditos inferiores a 2000, el exceso del límite por compra o el incumplimiento del límite mensual se producirían.
401Falta la clave API del agente o no es válida.
402El pago con Stripe falló o no hay ningún método de pago válido registrado.
403Facturación de la cuenta suspendida.
405Método no permitido: el punto final requiere POST.
Dominios especiales

Mantenemos dos listas útiles para la búsqueda de dominios: listas de ignorados y listas de sufijos incorporados.

Lista de ignorados
TEsta es nuestra lista interna de dominios que no indexamos. Están bloqueados, contienen demasiadas tecnologías engañosas o demasiados subdominios con contenido generado por el usuario.

BuiltWith Lista de sufijos
Esto se basa en la Lista de sufijos públicos pero incluye muchas entradas adicionales para empresas con subdominios que deberían considerarse dominios de nivel superior. Esta lista nos proporciona una mejor visibilidad para los sitios web internos, por ejemplo, lleva a northernbeaches.nsw.gov.au al nivel superior sobre nsw.gov.au.

Ignorar dominios (XML, JSON or TXT)
https://api.builtwith.com/ignoresv1/api.json
Dominios de sufijo (XML, JSON or TXT)
https://api.builtwith.com/suffixv1/api.json
Códigos de error

Tenga en cuenta que no se pueden garantizar los mensajes de error en este formato; su implementación también debe considerar los códigos de respuesta distintos de 200 como errores. La propiedad Lookup será nula (json) o no se proporcionará (xml) si el error está relacionado con el servidor. Ver todos los posibles códigos de error bien formados.

Condiciones de uso

Nuestro términos estándar cubrir el uso de todas nuestras API.

En general, puede usar la API para mejorar su producto de diversas maneras. La única limitación es que no puede revender los datos tal cual ni proporcionar funcionalidad duplicada a builtwith.com y sus servicios asociados.