Créditos, resultados desconhecidos e uso
Um gênero null bem-sucedido é cobrado conforme o custo do modo selecionado. A validação de telefone custa 1 crédito mesmo quando valid é false. Erros de validação anteriores à cobrança e previsões com falha não consomem créditos após um reembolso confirmado.
Um saldo inicial positivo basta para iniciar uma operação individual ou em lote. A cobrança final pode deixar o saldo negativo: 1 crédito inicial menos uma operação de IA de 2 créditos deixa -1. Saldos zero ou negativos bloqueiam novas operações cobradas. Reembolsos continuam permitidos.
Leia meta.usage.billing_status: not_charged significa que não houve débito (charged_credits: 0); confirmed significa que a cobrança líquida é conhecida; unconfirmed significa que charged_credits é null e o resultado precisa ser verificado. remaining_credits pode ser negativo ou null se não estiver disponível. É um retrato do saldo no momento da conclusão e pode mudar com requisições simultâneas.
GET /usage é gratuito. Retorna remaining_credits e expires_at e, no teste por IP, também resets_at, limit e period_seconds. O limite do teste por IP é 10 e period_seconds é 86400; esses campos são null em contas com chave de API. resets_at não é o vencimento de uma assinatura.
A V1 e a V2 compartilham o saldo. As gravações de saldo existentes da V1 podem concorrer com a V2; não conte com uma garantia de cobrança exatamente uma vez entre as versões.
{
"data": {
"remaining_credits": 9,
"expires_at": "2026-09-26T12:00:00.000Z",
"resets_at": "2026-09-26T12:00:00.000Z",
"limit": 10,
"period_seconds": 86400
},
"meta": {
"request_id": "11111111-1111-4111-8111-111111111111",
"duration_ms": 12,
"access": {
"mode": "ip_trial",
"reason": "api_key_missing"
},
"usage": {
"charged_credits": 0,
"remaining_credits": 9,
"billing_status": "not_charged",
"resets_at": "2026-09-26T12:00:00.000Z",
"limit": 10,
"period_seconds": 86400
}
}
}Consultar o saldo atual
GET /api/v2/usage é gratuito, usa autenticação Bearer e não tem parâmetros de consulta. Sem chave, a requisição lê a cota atual do teste por IP.
Escolha uma linguagem de programação. Configure sua chave de API, depois execute o exemplo no seu servidor.
Esta consulta de saldo não custa créditos. Ela ainda conta para os limites de requisições.
Antes de executar: acesso e tratamento de erros
Execute estes exemplos no seu servidor. Defina GENDERAPI_API_KEY no ambiente do processo com a sua chave de API existente. Confirme que meta.access.mode é api_key: uma chave não reconhecida pode levar ao teste por IP.
Respostas JSON com HTTP 4xx e 5xx preservam o corpo do erro e retornam um código de saída diferente de zero. Verifique code, action e meta.usage.billing_status antes de fazer uma nova tentativa.
Guia de erros e novas tentativas →cURL 7.76+ em um shell POSIX. Execute no seu terminal. Documentação do ambiente de execução
Node.js 22+; fetch nativo. Salve como example.mjs e execute node example.mjs. Documentação do ambiente de execução
Python 3.10+; biblioteca padrão. Salve como example.py e execute python3 example.py. Documentação do ambiente de execução
PHP 8+ com a extensão cURL. Salve como example.php e execute php example.php. Documentação do ambiente de execução
Java 17+; cliente HTTP padrão. Salve como GenderApiExample.java e execute java GenderApiExample.java. Documentação do ambiente de execução
Aplicação de console .NET 8+. Use como Program.cs em um projeto de console e depois execute dotnet run. Documentação do ambiente de execução
Go 1.22+; biblioteca padrão. Salve como main.go e execute go run main.go. Documentação do ambiente de execução
Campos da resposta de saldo
| Campo | Tipo | Pode ser null | Exemplo | Descrição |
|---|---|---|---|---|
data.remaining_credits | integer | Não | 99 | Saldo atual da conta ou do teste por IP; pode ser negativo. |
data.expires_at | string | Sim | null | Expiração da conta ou do teste por IP em UTC (ISO 8601), quando disponível. |
data.resets_at | string | Sim | "2026-09-27T12:00:00.000Z" | Momento da renovação do teste por IP em UTC (ISO 8601); null para contas com chave de API ou quando desconhecido. |
data.limit | integer | Sim | 10 | Cota do teste por IP; null para contas com chave de API. |
data.period_seconds | integer | Sim | 86400 | Janela do teste por IP em segundos; null para contas com chave de API. |
Metadados de acesso, cobrança e requisição
| Campo | Tipo | Pode ser null | Exemplo | Descrição |
|---|---|---|---|---|
meta.request_id | string | Não | "550e8400-e29b-41d4-a716-446655440000" | Identificador único desta tentativa HTTP; também enviado em X-Request-ID. |
meta.duration_ms | integer | Não | 42 | Tempo de processamento da requisição em milissegundos. |
meta.access.mode | string | Não | "api_key" | api_key, ip_trial ou unauthenticated. Verifique api_key ao usar uma conta paga. |
meta.access.reason | string | Sim | null | Motivo do uso do teste por IP: api_key_missing, api_key_invalid ou api_key_not_found; caso contrário, null. |
meta.usage.charged_credits | integer | Sim | 1 | Créditos líquidos cobrados. Zero antes da cobrança ou após reembolso integral confirmado; null se a cobrança não estiver confirmada. |
meta.usage.remaining_credits | integer | Sim | 99 | Saldo ao concluir a operação. Pode ser negativo; null se indisponível ou se a cobrança não estiver confirmada. |
meta.usage.billing_status | string | Não | "confirmed" | not_charged, confirmed ou unconfirmed. Verifique antes de repetir uma previsão com falha. |
meta.usage.resets_at | string | Sim | "2026-09-27T12:00:00.000Z" | Momento da renovação do teste por IP em UTC (ISO 8601); null para contas com chave de API ou quando desconhecido. |
meta.usage.limit | integer | Sim | 10 | Cota do teste por IP; null para contas com chave de API. |
meta.usage.period_seconds | integer | Sim | 86400 | Janela do teste por IP em segundos; null para contas com chave de API. |