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.
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
missing_api_key/invalid_api_key/plan_required— siehe Fehlerbehandlung.
Kontonutzung abrufen
Ein paginierter, neueste-zuerst-Kontobuch aller credit-relevanten Ereignisse auf Ihrem Konto – Extraktionsabzüge, Bbox-Anmerkungsabzüge und Rückerstattungen. Entwickelt für die Abrechnung „Wie viele Credits hat mich das gekostet?“, nicht für die Steuerung einer Benutzeroberfläche (vergleiche die vorformatierten Anzeigestrings von /profile/usage_history, die dieser Endpunkt nicht zurückgibt – Sie erhalten stattdessen strukturierte, signierte Betrag-Werte).
Parameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
limit | Abfrage, optional | integer | 1–200. Standard 50. |
batch_name | Abfrage, optional | string | Schränkt das Kontobuch auf Einträge für einen Batch ein – „Wie viele Credits hat mich Batch X gekostet.“ |
page_token | Abfrage, optional | string | Undurchsichtiger Cursor aus dem next_page_token einer vorherigen Antwort. Dieser Endpunkt paginiert neueste-zuerst (anders als andere v1-Listenendpunkte, die älteste-zuerst paginieren) – der Token bleibt undurchsichtig und funktioniert auf die gleiche Weise, nur die zugrunde liegende Reihenfolge unterscheidet sich. Siehe Paginierung. |
Betrag ist mit Vorzeichen versehen: negativ für Ausgaben (Extraktions-/Bbox-Abzüge), positiv für Gutschriften (Rückerstattungen/Stornierungsrückerstattungen) – die Summierung der Betrag-Werte einer Seite ergibt also die Nettoveränderung auf dieser Seite. document_id verwendet denselben ID-Raum wie die document_id von Dokumenten (das interne Kontobuch nennt es task_id; dieser Endpunkt benennt es zur Konsistenz mit dem Rest von v1 um).
Mögliche Fehler
missing_api_key/invalid_api_key/plan_required— siehe Fehlerbehandlung.invalid_parameter— ungültigerlimit- oderpage_token-Wert.