---
title: "API reference"
description: "Endpoints, envelopes, and exact request shapes."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.uncaptcha.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

The production API is available at:

```text
https://api.uncaptcha.io/v1
```

## Endpoints

| Method | Path | Purpose |
| --- | --- | --- |
| `POST` | `/task/execute` | Execute any supported CAPTCHA or anti-bot task. |
| `GET` | `/balance/get` | Return the pay-as-you-go account balance. |

Both endpoints accept authentication through `X-Api-Key`.

## Response envelope

Successful responses contain `success: true` and a `data` object:

```json
{
  "success": true,
  "data": {}
}
```

Errors contain `success: false` and a human-readable `message`:

```json
{
  "success": false,
  "message": "X-Api-Key header is missing"
}
```

See [Execute task](/api-reference/execute-task) for the challenge endpoint or
[Retrieve balance](/api-reference/get-balance) for the balance endpoint.

Source: https://docs.uncaptcha.io/api-reference/index.mdx