# API reference

> Every operation of the Noptcha API, generated from the OpenAPI 3.1 description.

Source: https://noptcha.com/docs/api-reference/

Base URL `https://api.noptcha.com` (HTTPS only). This reference is generated from our OpenAPI 3.1 description, which is checked against the implementation by contract tests. The 2captcha legacy endpoints (`/in.php`,`/res.php`) are not part of it; see [2captcha legacy API](https://noptcha.com/docs/2captcha-api.md).

## OpenAPI

-   [openapi.json](https://noptcha.com/openapi.json) and [openapi.yaml](https://noptcha.com/openapi.yaml): OpenAPI 3.1.0, API version 1.0.0.
-   [All schemas](https://noptcha.com/docs/api-reference/schemas.md).
-   Task parameter schemas also have their own URLs, for example [/schemas/recaptcha.v2.params.json](https://noptcha.com/schemas/recaptcha.v2.params.json) (JSON Schema 2020-12).

## Compatibility

The anti-captcha compatible JSON protocol.

| Endpoint | Summary |
| --- | --- |
| [POST `/createTask`](https://noptcha.com/docs/api-reference/compat-create-task.md) | Create a task |
| [POST `/getBalance`](https://noptcha.com/docs/api-reference/compat-get-balance.md) | Get the balance |
| [POST `/getTaskResult`](https://noptcha.com/docs/api-reference/compat-get-task-result.md) | Get a task's result |
| [POST `/reportCorrectRecaptcha`](https://noptcha.com/docs/api-reference/compat-report-correct-recaptcha.md) | Report a correct token |
| [POST `/reportIncorrectImageCaptcha`](https://noptcha.com/docs/api-reference/compat-report-incorrect-image-captcha.md) | Report a wrong image answer |
| [POST `/reportIncorrectRecaptcha`](https://noptcha.com/docs/api-reference/compat-report-incorrect-recaptcha.md) | Report a wrong token |

## Tasks

Create and poll tasks, report wrong answers (native API).

| Endpoint | Summary |
| --- | --- |
| [POST `/v1/tasks`](https://noptcha.com/docs/api-reference/create-task.md) | Create a task |
| [GET `/v1/tasks/{id}`](https://noptcha.com/docs/api-reference/get-task.md) | Get a task |
| [POST `/v1/tasks/{id}/feedback`](https://noptcha.com/docs/api-reference/send-task-feedback.md) | Report whether an answer worked |

## Account

Balance, task types and prices, the key itself, usage, the public catalog (native API).

| Endpoint | Summary |
| --- | --- |
| [GET `/v1/balance`](https://noptcha.com/docs/api-reference/get-balance.md) | Get the balance |
| [GET `/v1/catalog`](https://noptcha.com/docs/api-reference/get-catalog.md) | Get the public catalog and list prices |
| [GET `/v1/me`](https://noptcha.com/docs/api-reference/get-me.md) | Describe the current key |
| [GET `/v1/types`](https://noptcha.com/docs/api-reference/list-types.md) | List task types and prices |
| [GET `/v1/usage`](https://noptcha.com/docs/api-reference/get-usage.md) | Get usage |