Referencia de la API

Proveedores de IA

Proveedores de IA conectados directamente con una clave de solo lectura, y los facturadores de IA que puedes agregar como proveedores.

Más sobre este recurso

Nuevo con los controles de gasto en IA. Además de las líneas de IA de tus facturas de nube, Pleaxy lee los informes de coste y uso de los proveedores de IA a los que pagas directamente. OpenAI y Anthropic usan una clave de administrador de solo lectura; Mistral también, cuando la organización tiene su Admin API (una función de Enterprise); OpenRouter, una clave de gestión; CoreWeave, un token de acceso a la API con el rol Billing Viewer; Databricks, el secreto OAuth de una entidad de servicio; para Snowflake, Pleaxy genera un par de claves cuya clave pública asignas a un usuario de servicio. Lambda, Nebius, Crusoe y los facturadores por puesto (Cursor, GitHub, Microsoft) no tienen ninguna API de facturación que Pleaxy pueda leer: agrégalos como proveedores y sus facturas se comparan con el contrato. La clave se comprueba con una lectura antes de guardar nada, se guarda cifrada, nunca se devuelve (solo sus cuatro últimos caracteres, keyHint) y nunca se usa para cambiar nada en el proveedor. Las líneas de cada proveedor conectado se leen a diario y aparecen en Gasto en IA como su propio facturador, frente a las órdenes de compra emitidas a su entrada de proveedor. Cada facturador de IA tiene una entrada de proveedor que Pleaxy crea de antemano y que puedes agregar sin conectar: sus facturas y órdenes funcionan entonces como las de cualquier proveedor. Un proveedor conectado cuenta para el límite de proveedores del plan, igual que una cuenta de nube. El conector de cada proveedor se activa por región; hasta entonces, conectar responde 404 y agregarlo como proveedor sigue funcionando.

Listar proveedores de IA

Lista los proveedores de IA conectados del espacio de trabajo.

GET/v1/workspaces/{regionId}/ai-providers

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Cada conexión directa con un proveedor de IA del espacio de trabajo, conectada o pendiente: de qué proveedor se trata, la cuenta que lee, los cuatro últimos caracteres de la clave, cuándo se sincronizó por última vez y cómo fue. La clave en sí nunca se devuelve. Necesita acceso 'view' a los proveedores o a las facturas.

Campos de la respuesta

  • accountLabelstring

    Cómo llama el proveedor a la organización o cuenta que lee la clave.

  • keyHintstring

    Los cuatro últimos caracteres de la clave, el único rastro de ella que muestra Pleaxy. Ausente para Snowflake, cuyo par de claves generó Pleaxy.

  • statusstring

    connected, o pending para un par de claves de Snowflake cuya clave pública aún no se ha asignado al usuario de servicio: SyncAiProvider lo comprueba y termina de conectar.

  • snowflakeobject

    Solo Snowflake: el identificador de cuenta, el usuario de servicio, el warehouse y el rol opcional con los que inicia sesión el par de claves, y la clave pública (PEM) y su huella para asignarla con ALTER USER ... SET RSA_PUBLIC_KEY.

  • creditPriceobject

    Solo Snowflake: el precio por crédito de tu contrato, que convierte los créditos en dinero. Sin él, las líneas de IA del proveedor quedan en créditos, con currency credits, y nunca se suman con dinero.

  • supplierConnectionIdstring

    La entrada de proveedor a la que está asociado el proveedor; Gasto en IA compara sus líneas con las órdenes de compra emitidas a ella.

  • currencystring

    La moneda de facturación del proveedor, tal como la da su informe de costes.

  • lastSyncStatusstring

    Cómo fue la última lectura: ok, error (lastSyncError indica por qué; lastSyncErrorCode es access_revoked cuando la clave ya no funciona) o throttled (el proveedor pidió a Pleaxy que esperara; la próxima ejecución lo vuelve a intentar).

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/ai-providers
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/ai-providers" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 200 OK
[
   {
      "id": "string",
      "provider": "openai" | "anthropic" | "mistral" | "snowflake" | "openrouter" | "databricks" | "coreweave",
      "accountLabel": "string",
      "keyHint": "string",
      "status": "connected" | "pending",
      "connectedAt": "string",
      "connectedBy": "string",
      "snowflake": { "account": "string", "user": "string", "warehouse": "string", "role": "string", "publicKeyPem": "string", "publicKeyFingerprint": "string" },
      "creditPrice": { "amount": number, "currency": "string", "kind": "on_demand" | "capacity" | "commit" },
      "supplierConnectionId": "string",
      "currency": "string",
      "lastSyncedAt": "string",
      "lastSyncStatus": "ok" | "error" | "throttled",
      "lastSyncError": "string",
      "lastSyncErrorCode": "string"
   }
]

Crear proveedor de IA

Conecta un proveedor de IA con una clave de solo lectura.

POST/v1/workspaces/{regionId}/ai-providers

Cuerpo

  • provider"openai" | "anthropic" | "mistral" | "snowflake" | "openrouter" | "databricks" | "coreweave"Obligatorio

    El proveedor que se conecta. Su conector debe estar activado en la región.

  • keystring

    Todos los proveedores salvo Snowflake, obligatorio: una clave de solo lectura. La clave de administrador de OpenAI empieza por sk-admin- (Organization settings › Admin keys); la de Anthropic, por sk-ant-admin (Claude Console, Settings › Admin keys); la de Mistral es una clave de Admin API; la clave de gestión de OpenRouter empieza por sk-or-; la de CoreWeave es un token de acceso a la API; la de Databricks es el secreto OAuth de la entidad de servicio. Nunca se registra en logs ni se devuelve.

  • snowflakeobject

    Snowflake, obligatorio: { account, user, warehouse, role? }: el identificador de cuenta (orgname-account_name), el usuario de servicio, el warehouse en el que se ejecuta la consulta de uso y un rol opcional.

  • databricksobject

    Databricks, obligatorio: { host, clientId, warehouseId }: el host del workspace (un dominio de Databricks), el client id OAuth de la entidad de servicio y el SQL warehouse en el que se ejecutan las lecturas de facturación; key es el secreto OAuth de la entidad. La entidad necesita SELECT sobre system.billing (y system.serving para los recuentos de tokens).

  • creditPriceobject

    Snowflake y Databricks, opcional: { amount, currency, kind }, con kind on_demand, capacity o commit: el precio por crédito (Snowflake) o por DBCU (Databricks) de tu contrato. Sin él, las líneas de Snowflake quedan en créditos y las de Databricks se valoran al precio de lista de la cuenta.

Devuelve

201 Created con el objeto que se muestra en la respuesta.

Más detalles

Conecta un proveedor de IA directo. Para OpenAI, Anthropic y Mistral, envía la clave de administrador de solo lectura: Pleaxy hace una lectura con ella y, solo si funciona, la guarda cifrada, agrega la entrada de proveedor del proveedor a tus proveedores y devuelve la conexión. Para Snowflake, envía dónde iniciar sesión: Pleaxy genera un par de claves y devuelve la conexión en pending, con la clave pública que hay que asignar al usuario de servicio; después, SyncAiProvider la comprueba. Cinco comprobaciones fallidas por proveedor en una hora y luego hay que esperar. Necesita acceso 'create' a los proveedores.

Errores

  • 400 Bad Request - La validación falló; falta la clave o no es la clave de administrador de ese proveedor; el proveedor no la aceptó (no autorizada, prohibida, sin Admin API, ocupado o inaccesible, y no se guardó nada); cinco comprobaciones fallidas en la última hora; o el plan de la región alcanzó su límite de proveedores.
  • 404 Not Found - Proveedor desconocido, o su conector no está activado en esta región.
  • 409 Conflict - El proveedor ya está conectado en el espacio de trabajo.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
POST /v1/workspaces/{regionId}/ai-providers
Solicitud
POST /v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.buyer/ai-providers

{ "provider": "anthropic", "key": "sk-ant-admin01-…" }
Respuesta · 201 Created
{
   "id": "aip_01k8q2m4xv7c9n3p5t6r8w0yzb",
   "provider": "anthropic",
   "accountLabel": "Northwind Labs",
   "keyHint": "f3Qa",
   "status": "connected",
   "connectedAt": "2026-10-30T09:12:44.000Z",
   "supplierConnectionId": "sc_01k8q2m5a1b2c3d4e5f6g7h8j9"
}

Sincronizar proveedor de IA

Lee ahora el coste y el uso de un proveedor de IA.

POST/v1/workspaces/{regionId}/ai-providers/{id}/sync

Parámetros

  • idstringObligatorio

    El id de la conexión con el proveedor de IA.

Devuelve

201 Created con el objeto que se muestra en la respuesta.

Más detalles

Lee ahora los informes de coste y uso de un proveedor en lugar de esperar a la ejecución diaria, y devuelve la conexión con su nuevo estado de sincronización. Para una conexión de Snowflake en pending, primero comprueba que el par de claves inicia sesión y la marca como connected. Una vez cada 15 minutos por proveedor. No lleva cuerpo. Necesita acceso 'create' a los proveedores o acceso 'edit' a las facturas.

Errores

  • 400 Bad Request - Se sincronizó hace menos de 15 minutos, o un par de claves de Snowflake en pending sigue sin poder iniciar sesión (no cambió nada).
  • 404 Not Found - No existe esa conexión en el espacio de trabajo, o se desactivó el conector del proveedor.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
POST /v1/workspaces/{regionId}/ai-providers/{id}/sync
Solicitud
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/ai-providers/{id}/sync" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 201 Created
{
   "id": "string",
   "provider": "openai" | "anthropic" | "mistral" | "snowflake" | "openrouter" | "databricks" | "coreweave",
   "status": "connected" | "pending",
   "lastSyncedAt": "string",
   "lastSyncStatus": "ok" | "error" | "throttled",
   "lastSyncError": "string"
}

Eliminar proveedor de IA

Desconecta un proveedor de IA.

DELETE/v1/workspaces/{regionId}/ai-providers/{id}

Parámetros

  • idstringObligatorio

    El id de la conexión con el proveedor de IA.

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Desconecta un proveedor de IA directo: se eliminan la conexión y su clave cifrada, y se registra quién la desconectó. Las líneas de IA ya leídas se conservan como historial, y la entrada de proveedor se mantiene. Revoca también la clave en el proveedor (en Snowflake, quita la clave pública del usuario).

Sesión iniciada con acceso 'edit' a los proveedores; una clave de API recibe 403.

Errores

  • 403 Forbidden - El llamador es una clave de API o no tiene 'edit' en los proveedores.
  • 404 Not Found - No existe esa conexión en el espacio de trabajo.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
DELETE /v1/workspaces/{regionId}/ai-providers/{id}
Solicitud
curl -X DELETE "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/ai-providers/{id}" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 200 OK
{
   "id": "string",
   "provider": "openai" | "anthropic" | "mistral" | "snowflake" | "openrouter" | "databricks" | "coreweave"
}

Agregar proveedor de IA como proveedor

Agrega un facturador de IA como proveedor sin conectarlo.

POST/v1/workspaces/{regionId}/ai-providers/{provider}/supplier

Parámetros

  • providerstringObligatorio

    Uno de openai, anthropic, mistral, cohere, xai, openrouter, snowflake, databricks, coreweave, lambda, nebius, crusoe, cursor, github o microsoft (ListAiInvoicers los lista).

Devuelve

201 Created con el objeto que se muestra en la respuesta.

Más detalles

Agrega un facturador de IA a tu lista de proveedores a partir de la entrada que Pleaxy crea de antemano, sin conectar nada, para que puedas emitirle órdenes de compra y registrar sus facturas. Funciona con todos los facturadores de IA, incluidos los que Pleaxy no puede leer (su gasto sale de sus facturas). Devuelve la entrada existente si la hay, y conectar más adelante vincula con la misma entrada. No lleva cuerpo. Necesita acceso 'create' a los proveedores.

Errores

  • 404 Not Found - Facturador de IA desconocido.
  • 409 Conflict - Código SUPPLIER_ALREADY_LISTED: un proveedor con ese nombre ya tiene una incorporación en curso o aprobada.
  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
POST /v1/workspaces/{regionId}/ai-providers/{provider}/supplier
Solicitud
curl -X POST "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/ai-providers/{provider}/supplier" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 201 Created
{
   "id": "string",
   "buyerOrgId": "string",
   "supplierName": "string",
   "aiProvider": "string",
   "status": "pending_invite" | "invited" | "in_progress" | "submitted" | "approved" | "rejected",
   "createdAt": "string"
}

Listar facturadores de IA

Lista los facturadores de IA que Pleaxy crea de antemano como proveedores.

GET/v1/workspaces/{regionId}/ai-invoicers

Devuelve

200 OK con el objeto que se muestra en la respuesta.

Más detalles

Los facturadores de IA para los que Pleaxy mantiene una entrada de proveedor: sus nombres, las entidades legales desde las que facturan por región, las monedas en las que facturan, si facturan por factura, por créditos prepagados o por ambos, los dominios desde los que llegan sus correos de facturas, cómo lee Pleaxy su gasto y si ese lector está activado en tu región (connectable). Pleaxy mantiene la lista; las entidades legales y los dominios son una pista para el destinatario de la factura, nunca una comprobación. Necesita acceso 'view' a los proveedores o a las facturas.

Campos de la respuesta

  • legalEntitiesArray<object>

    La entidad que factura a un comprador en cada región, default para cada región no listada, con su país.

  • credentialstring

    Cómo lee Pleaxy el gasto del facturador: admin_key (una clave de solo lectura que pegas), key_pair (un par de claves que genera Pleaxy) o none (sin API de lectura; su gasto sale de sus facturas).

  • shapestring

    En qué se miden sus líneas: tokens, credits (Snowflake, Databricks) o capacity (horas de GPU).

  • connectableboolean

    Si CreateAiProvider puede conectarlo ahora en esta región.

Errores

  • 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
  • 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
GET /v1/workspaces/{regionId}/ai-invoicers
Solicitud
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/ai-invoicers" \
  -H "X-Api-Key: $PLEAXY_API_KEY"
Respuesta · 200 OK
[
   {
      "id": "string",
      "name": "string",
      "legalEntities": [ { "region": "us" | "eu" | "default", "name": "string", "country": "string" } ],
      "billingCurrencies": [ "string" ],
      "billing": [ "invoice" | "prepaid_credits" ],
      "senderDomains": [ "string" ],
      "credential": "admin_key" | "key_pair" | "none",
      "tier": "direct" | "data_platform" | "host" | "neocloud" | "seats",
      "shape": "tokens" | "credits" | "capacity" | "seats",
      "contactHint": "string",
      "connectable": boolean
   }
]
Habla con nosotros