Referencia de la API
Créditos
La API usa tus créditos de SciFig: un saldo para el sitio web, la API y MCP.
Consultar el saldo#
GET /credits, con el ámbito figures:read, devuelve tu saldo, los créditos reservados por tareas en ejecución, tu plan y sus límites de tareas:
{
"balance": 2950,
"reserved": 100,
"granted_scopes": ["figures:read", "figures:generate"],
"plan": "plus",
"plan_level": 2,
"limits": { "concurrent_tasks": 5, "tasks_per_hour": 200 },
"top_up_url": "https://scifig.ai/pricing?utm_source=api"
}planesfree,starter,plusopro. Una cuenta con saldo positivo de créditos adquiridos en paquetes se trata comopromientras dure ese saldo.tasks_per_houres 200 en todos los planes;concurrent_tasksdepende del plan.top_up_urlincluyeutm_source=apien las solicitudes directas a la API yutm_source=mcpen las realizadas a través del servidor MCP.granted_scopesenumera los permisos de las credenciales actuales:figures:ready, cuando está permitido,figures:generate.
GET /pricing devuelve todos los precios sin autenticación; los precios de estas páginas se leen de la misma tabla. No hay un plan de API independiente: compra créditos o una suscripción en la página de precios.
Ciclo de vida de la reserva#
- Crear una tarea reserva su precio de forma atómica; dos solicitudes nunca pueden gastar los mismos créditos.
- Sin créditos suficientes, la respuesta es
402 INSUFFICIENT_CREDITScondetails.top_up_url: no se reserva ni se ejecuta nada. La solicitud rechazada permanece enGET /jobscomo tarea fallida con ese error y repetir su clave devuelve la misma respuesta. - Una tarea completada cobra su reserva exactamente una vez; una tarea fallida o cancelada la devuelve íntegramente. Los reintentos internos no vuelven a reservar y repetir un
Idempotency-Keyreutiliza la reserva original. - Cada tarea indica
credits.reserved,credits.chargedycredits.refunded, leídos del registro contable. - Los créditos se gastan en el mismo orden que en el sitio web: primero los que caducan antes y, por último, los de paquetes, que no caducan.
cURL#
curl https://scifig.ai/api/v1/credits \
-H "Authorization: Bearer $SCIFIG_API_KEY"JavaScript#
const response = await fetch('https://scifig.ai/api/v1/credits', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
},
});
const result = await response.json();
console.log(response.status, result);Python#
import os
import requests
headers = {
"Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
}
response = requests.get(
"https://scifig.ai/api/v1/credits",
headers=headers,
timeout=60,
)
print(response.status_code, response.json())