API-Referenz

Credits

Name: SciFig
Author: SciFig

Die API verwendet Ihre SciFig-Credits: ein Guthaben für Website, API und MCP.

Guthaben abfragen#

GET /credits mit Berechtigungsbereich figures:read gibt Ihr Guthaben, die von laufenden Aufträgen reservierten Credits, Ihren Tarif und dessen Aufgabenlimits zurück:

{
  "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"
}

plan ist free, starter, plus oder pro. Ein Konto mit positivem Guthaben aus Credit-Paketen wird als pro behandelt, solange dieses Guthaben vorhanden ist.
tasks_per_hour ist für jeden Tarif 200; concurrent_tasks hängt vom Tarif ab.
top_up_url enthält utm_source=api bei direkten API-Anfragen und utm_source=mcp bei Anfragen über den MCP-Server.
granted_scopes listet die Berechtigungen der aktuellen Zugangsdaten auf: figures:read und, falls erlaubt, figures:generate.

GET /pricing gibt alle Preise ohne Authentifizierung zurück. Die Preise auf diesen Seiten stammen aus derselben Tabelle. Es gibt keinen gesonderten API-Tarif: Kaufen Sie Credits oder ein Abonnement auf der Preisseite.

Lebenszyklus einer Reservierung#

Das Erstellen eines Auftrags reserviert seinen Preis atomar; zwei Anfragen können nie dieselben Credits verbrauchen.
Ohne ausreichende Credits lautet die Antwort 402 INSUFFICIENT_CREDITS mit details.top_up_url: Es wird nichts reserviert oder ausgeführt. Die abgelehnte Anfrage bleibt in GET /jobs als fehlgeschlagener Auftrag mit diesem Fehler erhalten. Eine Wiederholung mit ihrem Schlüssel gibt dieselbe Antwort zurück.
Bei einem erfolgreichen Auftrag wird die Reservierung genau einmal abgerechnet; ein fehlgeschlagener oder abgebrochener Auftrag gibt sie vollständig zurück. Interne Wiederholungen reservieren nicht erneut, und eine Wiederholung eines Idempotency-Key verwendet die ursprüngliche Reservierung.
Jeder Auftrag meldet credits.reserved, credits.charged und credits.refunded, aus dem Ledger gelesen.
Credits werden in derselben Reihenfolge wie auf der Website verbraucht: zuerst die am frühesten ablaufenden Credits, zuletzt die nicht ablaufenden Credits aus Paketen.

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())

ZurückAufträge und begrenzte Wartezeit WeiterFehlerFehlerstruktur, alle Fehlercodes und Hinweise zum Wiederholen von Anfragen.