Compte
Deux points d'accès en lecture seule pour le compte propriétaire de la clé API : un instantané du plan et des crédits disponibles (avec les deux nombres dont un SDK a besoin pour se limiter), ainsi qu'un registre paginé de la consommation de crédits pour un rapprochement en libre-service.
Obtenir le compte
Renvoie le plan et les crédits effectifs de votre compte — si votre compte est membre d'une équipe, cela reflète déjà le plan/le pool de crédits du propriétaire de l'équipe, et non votre propre plan d'adhésion individuel.
Paramètres
Aucun — le compte est entièrement déterminé par la clé API dans l'en-tête Authorization.
max_batch_size et upload_concurrency sont fournis pour qu'un SDK client puisse auto-limiter sa propre boucle de téléchargement au lieu de découvrir ces limites en rencontrant d'abord des erreurs invalid_parameter/rate_limit_exceeded.
Erreurs possibles
missing_api_key/invalid_api_key/plan_required— voir Gestion des erreurs.
Obtenir l'utilisation du compte
Registre paginé, du plus récent au plus ancien, de chaque événement affectant vos crédits — déductions d'extraction, déductions d'annotation par boîte englobante et remboursements. Conçu pour répondre à « combien de crédits cela m'a-t-il coûté », pas pour alimenter une interface utilisateur (comparez avec les chaînes d'affichage préformatées de /profile/usage_history, que ce point de terminaison ne renvoie pas — vous obtenez des valeurs amount structurées et signées à la place).
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
limit | requête, facultatif | entier | 1–200. Par défaut 50. |
batch_name | requête, facultatif | chaîne | Limiter le registre aux entrées d'un seul lot — « combien de crédits le lot X m'a-t-il coûté. » |
page_token | requête, facultatif | chaîne | Curseur opaque provenant du next_page_token d'une réponse précédente. Ce point de terminaison pagine du plus récent au plus ancien (contrairement aux autres points de terminaison de liste v1, qui paginent du plus ancien au plus récent) — le jeton reste opaque et effectue le même aller-retour, seul l'ordre sous-jacent diffère. Voir Pagination. |
amount est signé : négatif pour les dépenses (déductions d'extraction/bbox), positif pour les crédits retournés (remboursements/remboursements d'annulation) — ainsi, additionner les valeurs amount d'une page vous donne le changement net pour cette page. document_id utilise le même espace d'ID que le document_id de Documents (le registre interne l'appelle task_id ; ce point de terminaison le renomme pour la cohérence avec le reste de v1).
Erreurs possibles
missing_api_key/invalid_api_key/plan_required— voir Gestion des erreurs.invalid_parameter—limitoupage_tokeninvalide.