Returns what an API key is and whether it can execute a task right now. It accepts every key type, including unlimited and bundle package keys, so use it to check that a key works before sending tasks with it.
Request
curl --request GET \
--url https://api.uncaptcha.io/v1/key/info \
--header "X-Api-Key: $UNCAPTCHA_API_KEY"Response
The fields in data depend on the key type.
{
"success": true,
"data": {
"type": "unlimited",
"status": "active",
"usable": true,
"label": "Unlimited 30d",
"allowed_tasks": ["turnstile", "waf"],
"created_at": "2026-10-09T12:00:00Z",
"expires_at": "2026-11-08T12:00:00Z",
"thread_limit": 50,
"threads_in_use": 3
}
}{
"success": true,
"data": {
"type": "bundle",
"status": "active",
"usable": true,
"label": "Turnstile 5000",
"allowed_tasks": ["turnstile"],
"created_at": "2026-10-09T12:00:00Z",
"expires_at": "2027-01-07T12:00:00Z",
"task_quota": 5000,
"tasks_used": 123,
"remaining": 4877
}
}{
"success": true,
"data": {
"type": "payg",
"status": "active",
"usable": true,
"allowed_tasks": [],
"balance": 12.5
}
}Fields
Fields that don’t apply to a key’s type are left out.
| Field | Key types | Description |
|---|---|---|
type |
All | payg, unlimited, or bundle. |
status |
All | active, paused, expired, exhausted, or disabled. Pay-as-you-go keys are always active. |
usable |
All | Whether the key can execute a task right now. See When a key isn’t usable. |
allowed_tasks |
All | Task types the key may run. An empty array means every task type is allowed. |
label |
Unlimited, bundle | Name of the package the key was issued for. |
created_at |
Unlimited, bundle | When the key was issued, in UTC. |
expires_at |
Unlimited, bundle | When the key expires, in UTC. While a package is paused its expiry clock stops, and this date moves forward when it resumes. |
balance |
Pay-as-you-go | Current account balance. |
thread_limit |
Unlimited | Most tasks the key can run at the same time. |
threads_in_use |
Unlimited | Tasks running on the key right now. Left out if it can’t be read. |
task_quota |
Bundle | Total solves included in the bundle. |
tasks_used |
Bundle | Solves used so far. Failed solves are refunded and don’t count. |
remaining |
Bundle | Solves left. |
The status is read when you make the request, so a key that was just disabled, paused, or used up is reported that way immediately.
When a key isn’t usable
usable is false when any of these is true. Each one matches the error
Execute task returns for the same key.
| Cause | How to tell | Execute task returns |
|---|---|---|
| The package is paused | status is paused |
403 |
| The key has expired | status is expired |
403 |
| The bundle is used up | status is exhausted |
403 |
| The key was disabled | status is disabled |
403 |
| The balance is empty | balance is 0 |
402 |
| The account isn’t allowed to run tasks | status is active and nothing above applies |
403 |
Errors
A key that exists but can’t run tasks still returns 200. Check usable and
status, not the HTTP status.
| Status | Message | What it means |
|---|---|---|
401 |
X-Api-Key header is missing |
Add the authentication header. |
404 |
User not found |
The key doesn’t exist. It may be mistyped, rotated, or deleted. |
500 |
Service error | Retry with backoff. |