Krediter, okända resultat och användning
Ett lyckat resultat med gender null debiteras enligt kostnaden för det valda läget. Validering av telefonnummer kostar 1 kredit även när valid är false. Valideringsfel före debitering och misslyckade prediktioner förbrukar inga krediter efter en bekräftad återbetalning.
Ett positivt startsaldo räcker för att starta en enskild åtgärd eller en batch. Den slutliga debiteringen kan göra saldot negativt: 1 kredit i startsaldo minus en AI-åtgärd för 2 krediter ger -1. Ett saldo på noll eller lägre blockerar nya debiterbara åtgärder. Återbetalningar är fortfarande möjliga.
Läs meta.usage.billing_status: not_charged betyder ingen debitering (charged_credits: 0), confirmed betyder att nettodebiteringen är känd och unconfirmed betyder att charged_credits är null och att utfallet måste kontrolleras. remaining_credits kan vara negativt, eller null om värdet inte finns. Det är en ögonblicksbild när åtgärden slutförs och kan ändras av samtidiga förfrågningar.
GET /usage är kostnadsfritt. Det returnerar remaining_credits och expires_at, och för IP-provperioden även resets_at, limit och period_seconds. Gränsen för provperioden är 10 och period_seconds är 86400; för konton med API-nyckel är dessa fält null. resets_at är inte slutdatumet för en prenumeration.
V1 och V2 delar samma saldo. Befintliga saldouppdateringar i V1 kan krocka med V2; lita inte på en garanti för exakt en debitering mellan versionerna.
{
"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
}
}
}Kontrollera aktuellt saldo
GET /api/v2/usage är kostnadsfritt, använder Bearer-autentisering och har inga frågeparametrar. Utan nyckel läses den aktuella kvoten för IP-provperioden.
Välj ett programmeringsspråk. Konfigurera din API-nyckel, kör sedan exemplet på din server.
Den här saldokontrollen kostar inga krediter, men den räknas mot gränserna för antal förfrågningar.
Innan du kör: åtkomst och felhantering
Kör exemplen på din server. Sätt GENDERAPI_API_KEY i processmiljön till din befintliga API-nyckel. Kontrollera att meta.access.mode är api_key: en nyckel som inte känns igen kan leda till IP-provperioden.
Vid JSON-svar med HTTP 4xx och 5xx behålls felinnehållet och exemplet avslutas med en slutstatus som inte är noll. Kontrollera code, action och meta.usage.billing_status innan du försöker igen.
Guide om fel och nya försök →cURL 7.76+ i ett POSIX-skal. Kör i terminalen. Dokumentation för körmiljön
Node.js 22+; inbyggd fetch. Spara som example.mjs och kör node example.mjs. Dokumentation för körmiljön
Python 3.10+; standardbiblioteket. Spara som example.py och kör python3 example.py. Dokumentation för körmiljön
PHP 8+ med tillägget cURL. Spara som example.php och kör php example.php. Dokumentation för körmiljön
Java 17+; inbyggd HTTP-klient. Spara som GenderApiExample.java och kör java GenderApiExample.java. Dokumentation för körmiljön
Konsolapplikation med .NET 8+. Använd som Program.cs i ett konsolprojekt och kör sedan dotnet run. Dokumentation för körmiljön
Go 1.22+; standardbiblioteket. Spara som main.go och kör go run main.go. Dokumentation för körmiljön
Fält i saldosvaret
| Fält | Typ | Kan vara null | Exempel | Beskrivning |
|---|---|---|---|---|
data.remaining_credits | integer | Nej | 99 | Aktuellt saldo för kontot eller IP-provperioden; kan vara negativt. |
data.expires_at | string | Ja | null | Tidpunkt i UTC (ISO 8601) då kontot eller provperioden upphör, om den är känd. |
data.resets_at | string | Ja | "2026-09-27T12:00:00.000Z" | Tidpunkt i UTC (ISO 8601) då IP-provperioden återställs; null för konton med API-nyckel eller om tidpunkten är okänd. |
data.limit | integer | Ja | 10 | Kvot för IP-provperioden; null för konton med API-nyckel. |
data.period_seconds | integer | Ja | 86400 | IP-provperiodens tidsfönster i sekunder; null för konton med API-nyckel. |
Metadata om åtkomst, debitering och förfrågan
| Fält | Typ | Kan vara null | Exempel | Beskrivning |
|---|---|---|---|---|
meta.request_id | string | Nej | "550e8400-e29b-41d4-a716-446655440000" | Unik identifierare för det här HTTP-försöket; skickas även i X-Request-ID. |
meta.duration_ms | integer | Nej | 42 | Bearbetningstid för förfrågan i millisekunder. |
meta.access.mode | string | Nej | "api_key" | api_key, ip_trial eller unauthenticated. Kontrollera att api_key rapporteras när du använder ett betalt konto. |
meta.access.reason | string | Ja | null | Orsak till att IP-provperioden användes: api_key_missing, api_key_invalid eller api_key_not_found; annars null. |
meta.usage.charged_credits | integer | Ja | 1 | Debiterade krediter netto. 0 före debitering eller efter en bekräftad fullständig återbetalning; null när debiteringen är obekräftad. |
meta.usage.remaining_credits | integer | Ja | 99 | Saldo när åtgärden slutförs. Kan vara negativt; null om saldot saknas eller debiteringen är obekräftad. |
meta.usage.billing_status | string | Nej | "confirmed" | not_charged, confirmed eller unconfirmed. Kontrollera detta innan du gör ett nytt försök med en misslyckad prediktion. |
meta.usage.resets_at | string | Ja | "2026-09-27T12:00:00.000Z" | Tidpunkt i UTC (ISO 8601) då IP-provperioden återställs; null för konton med API-nyckel eller om tidpunkten är okänd. |
meta.usage.limit | integer | Ja | 10 | Kvot för IP-provperioden; null för konton med API-nyckel. |
meta.usage.period_seconds | integer | Ja | 86400 | IP-provperiodens tidsfönster i sekunder; null för konton med API-nyckel. |