API reference

This reference is generated from the OpenAPI contract the API serves, version 0.1.0, so it always matches what the API does. New to the API? Start with the quickstart.

Basics

• The API is at https://api.zerocaptcha.io. Bodies are JSON.
• The REST API takes your key as a bearer token: Authorization: Bearer YOUR_API_KEY. The compatible format takes it as clientKey in the body. Keys are made in the dashboard; see API keys.
• A REST failure is a problem document (RFC 9457) with a stable code; the compatible format answers HTTP 200 with errorId 1 and an errorCode. Every code is in the errors reference.
• Every reply carries its request's ID in X-Request-Id. Quote it when you write to us.
• The whole contract is at /openapi.json on this site (download it), and at https://api.zerocaptcha.io/openapi.json, for code generators and API tools.

Operations

Tasks

• List tasks: GET /v1/tasks
• Create a task: POST /v1/tasks
• Live task updates: GET /v1/tasks/events
• Get a task: GET /v1/tasks/{id}
• Send a task's callback again: POST /v1/tasks/{id}/callback/resend
• Report a task's token: POST /v1/tasks/{id}/report

Compatible format

• Create a task (compatible): POST /createTask
• Report how a token did (CapSolver): POST /feedbackTask
• Get the balance (compatible): POST /getBalance
• Get a task's result (compatible): POST /getTaskResult
• Report a token that worked (2Captcha): POST /reportCorrect
• Report a token that worked (Anti-Captcha): POST /reportCorrectRecaptcha
• Report a refused token (2Captcha): POST /reportIncorrect
• Report a refused token (Anti-Captcha): POST /reportIncorrectRecaptcha

2Captcha format

• Submit a task (2Captcha): GET /in.php
• Submit a task by POST (2Captcha): POST /in.php
• Get a result or the balance (2Captcha): GET /res.php

Balance

• Get the balance: GET /v1/balance

Prices

• List prices: GET /v1/prices

Status feed

• Platform status: GET /v1/status

Site-owner opt-out

• Ask to opt a domain out: POST /v1/opt-out-requests

Abuse reports

• Report abuse: POST /v1/abuse-reports

Support messages

• Contact us: POST /v1/contact-messages
• Write to support: POST /v1/support-messages

Demo pages

• Check for a Cloudflare clearance: GET /v1/demo/clearance
• Check a demo token: POST /v1/demo/verify

Health

• Liveness probe: GET /healthz
• Readiness probe: GET /readyz

The contract

• This contract: GET /openapi.json

The dashboard's endpoints

The contract also describes the endpoints the dashboard itself calls, with a signed-in session and its CSRF token: account, session, keys, billing, usage, team, callbacks. They are how the dashboard signs you in and manages your keys and billing, not part of the API your code calls, so this reference leaves them out; an API key is refused by them.