Referenz

Account

Zwei schreibgeschützte Endpunkte für das Konto, das dem API-Schlüssel zugeordnet ist: eine Momentaufnahme des Plans und der verfügbaren Credits (mit den beiden Zahlen, die ein SDK zur Selbstregulierung benötigt) sowie ein paginiertes Verzeichnis des Credit-Verbrauchs für die eigenständige Abstimmung.

Account abrufen

Gibt den effektiven Plan und die Credits Ihres Kontos zurück – wenn Ihr Konto Mitglied eines Teams ist, spiegelt dies bereits den Plan/Credit-Pool des Teambesitzers wider, nicht Ihren eigenen individuellen Mitgliedschaftsplan.

GET /api/v1/account

Parameter

Keine – das Konto wird vollständig durch den API-Schlüssel im Authorization-Header bestimmt.

max_batch_size und upload_concurrency werden bereitgestellt, damit ein Client-SDK seine eigene Upload-Schleife selbst drosseln kann, anstatt diese Grenzen erst durch invalid_parameter/ rate_limit_exceeded-Fehler zu entdecken.

Mögliche Fehler

Kontonutzung abrufen

Ein paginierter, neueste-zuerst-Ledger aller credit-relevanten Ereignisse auf Ihrem Konto — Extraktionsabzüge, Bbox-Annotationsabzüge und Rückerstattungen. Entwickelt für die Abstimmung von „Wie viele Credits hat mich das gekostet?", nicht für den Betrieb einer Benutzeroberfläche (vergleichen Sie die vorformatierten Anzeigestrings von /profile/usage_history, die dieser Endpunkt nicht zurückgibt — Sie erhalten stattdessen strukturierte, signierte amount-Werte).

GET /api/v1/account/usage

Parameter

NameOrtTypBeschreibung
limitquery, optionalinteger1–200. Standard 50.
batch_namequery, optionalstringSchränkt den Ledger auf Einträge für einen Batch ein — „Wie viele Credits hat Batch X mich gekostet."
page_tokenquery, optionalstringUndurchsichtiger Cursor aus dem next_page_token einer vorherigen Antwort. Dieser Endpunkt paginiert neueste-zuerst (anders als andere v1-Listen-Endpunkte, die älteste-zuerst paginieren) — der Token bleibt undurchsichtig und funktioniert auf dieselbe Weise, nur die zugrunde liegende Reihenfolge unterscheidet sich. Siehe Paginierung.

amount ist signiert: negativ für Ausgaben (Extraktions-/Bbox-Abzüge), positiv für Credits zurück (Rückerstattungen/Stornierungsrückerstattungen) — die Summe der amount-Werte einer Seite ergibt also die Nettoveränderung über diese Seite. document_id verwendet denselben ID-Raum wie das document_id von Dokumenten (das interne Ledger nennt es task_id; dieser Endpunkt benennt es aus Konsistenz mit dem Rest von v1 um).

Die Höhe eines Abzugs ist nicht immer 1. Jedes Konto hat eine Modellstufe — Standard (die Standardeinstellung), Advanced oder Premium — die bestimmt, welches KI-Modell seine Extraktionen ausführt und wie viele Credits jedes verarbeitete Dokument kostet: 1 für Standard, 3 für Advanced, 6 für Premium. Es gibt keine Möglichkeit, dies pro API-Aufruf festzulegen; es wird dem Konto vom ImageToTable.ai-Team zugewiesen. Wenn ein Konto nicht auf Standard ist, trägt das Feld action ein Stufensuffix statt des bloßen Namens — deduction_advanced, deduction_premium — sodass Sie eine Nicht-Standard-Gebühr erkennen können, ohne amount direkt zu prüfen. Rückerstattungen werden von späteren Stufenänderungen nicht beeinflusst: Eine Aufgabe wird immer mit der Stufe erstattet, mit der sie tatsächlich beim Start der Verarbeitung belastet wurde, nicht mit der Stufe, auf der sich das Konto zufällig befindet, wenn die Rückerstattung ausgelöst wird. Daher stimmt die Höhe einer refund-Zeile immer mit der deduction/deduction_<tier>-Zeile überein, die sie umkehrt. Siehe Kontoeinstellungen & API-Verhalten für Details, wie dies mit jeder anderen kontobezogenen Einstellung interagiert, die v1 liest.

Mögliche Fehler

  • missing_api_key / invalid_api_key / plan_required — siehe Fehlerbehandlung.
  • invalid_parameter — ungültiger limit oder page_token.
📮 contact email: [email protected]