Conta
Dois endpoints somente leitura para a conta proprietária da chave de API: um instantâneo do plano e dos créditos disponíveis (com os dois números que um SDK precisa para se autorregular) e um registro paginado do consumo de créditos para reconciliação por autoatendimento.
Obter conta
Retorna o plano e os créditos efetivos da sua conta — se sua conta for membro de uma equipe, isso já reflete o plano/pool de créditos do proprietário da equipe, não seu plano de associação individual.
Parâmetros
Nenhum — a conta é determinada inteiramente pela chave de API no cabeçalho Authorization.
max_batch_size e upload_concurrency são fornecidos para que um SDK cliente possa autorregular seu próprio loop de upload em vez de descobrir esses limites ao encontrar erros invalid_parameter/ rate_limit_exceeded primeiro.
Erros possíveis
missing_api_key/invalid_api_key/plan_required— consulte Error Handling.
Obter uso da conta
Um histórico paginado, do mais recente para o mais antigo, de todos os eventos que afetam créditos na sua conta — deduções de extração, deduções de anotação de bbox e reembolsos. Criado para reconciliar "quantos créditos isso me custou", não para alimentar uma interface (compare com as strings de exibição pré-formatadas de /profile/usage_history, que este endpoint não retorna — você recebe valores estruturados de amount com sinal).
Parâmetros
| Nome | Local | Tipo | Descrição |
|---|---|---|---|
limit | query, opcional | integer | 1–200. Padrão 50. |
batch_name | query, opcional | string | Restringe o histórico a entradas de um único lote — "quantos créditos o lote X me custou." |
page_token | query, opcional | string | Cursor opaco do next_page_token de uma resposta anterior. Este endpoint pagina do mais recente para o mais antigo (diferente de outros endpoints de listagem v1, que paginam do mais antigo para o mais recente) — o token continua opaco e faz o mesmo round-trip, apenas a ordem subjacente difere. Consulte Pagination. |
amount tem sinal: negativo para gastos (deduções de extração/bbox), positivo para créditos devolvidos (reembolsos/reembolsos de cancelamento) — então somar os valores de amount de uma página dá a variação líquida daquela página. document_id usa o mesmo espaço de ID que o document_id de Documents (o ledger interno chama de task_id; este endpoint renomeia para consistência com o resto da v1).
A magnitude de uma dedução nem sempre é 1. Toda conta tem um Model Tier — Standard (o padrão), Advanced ou Premium — que decide qual modelo de IA executa as extrações e quantos créditos cada documento processado custa: 1 para Standard, 3 para Advanced, 6 para Premium. Não há como definir isso por chamada de API; é atribuído à conta pela equipe do ImageToTable.ai. Quando uma conta não está no Standard, o campo action carrega um sufixo de nível em vez do nome puro — deduction_advanced, deduction_premium — para que você identifique uma cobrança não-Standard sem inspecionar amount diretamente. Reembolsos não são afetados por mudanças posteriores de nível: uma tarefa é sempre reembolsada no nível em que foi realmente cobrada quando o processamento começou, não no nível em que a conta estiver quando o reembolso for disparado, então a magnitude de uma linha refund sempre corresponderá à linha deduction/deduction_<tier> que está revertendo. Consulte Account Settings & API Behavior para saber como isso interage com todas as outras configurações de nível de conta que a v1 lê.
Erros possíveis
missing_api_key/invalid_api_key/plan_required— consulte Tratamento de Erros.invalid_parameter—limitoupage_tokeninválidos.