OpenAPI specification

Download the public API schema to generate clients and import requests into your tools.

Download the specification

Download the public OpenAPI JSON, or view the JSON.

The document uses OpenAPI 3.1.1. It describes the customer endpoints, request and response schemas, bearer authentication, and Problem Details errors. The download is published from the same specification used to generate our client types.

Its stable URL is https://www.easycaptcha.to/docs/openapi.json. It contains the public API server URL, https://api.easycaptcha.to. Import it into an OpenAPI-compatible API client or generator that supports OpenAPI 3.1.

The vendor compatibility hosts use separate request formats and are documented in the NopeCHA, 2Captcha, and CapSolver reference. This specification covers the native API only.

Generate a TypeScript client

Hey API’s openapi-ts can generate a client from the downloaded file. With Node.js 22 or newer:

curl --fail --output openapi.json https://www.easycaptcha.to/docs/openapi.json
npx @hey-api/openapi-ts -i openapi.json -o src/client

Configure the generated client’s bearer authentication with your API key before calling authenticated endpoints. Keep the key out of source control. Pin your generator version in your project so client generation remains reproducible.

What the schema covers

• Task submission, polling, and feedback.
• Account balance, effective rates, and recent task history.
• Extension releases and download links.
• Task results, identifiers, timestamps, monetary values, and error responses.

Prices and balances use decimal integer strings in microcents. Use integer arithmetic when handling them: 100,000,000 microcents equals one USD. GET /v1/rates supplies your account’s current prices; the schema’s examples do not override those rates.

Keep generated clients current

Download the specification again when updating your integration and regenerate your client. Treat queued and running as pending states and handle an embedded task error separately from HTTP errors.

Generated types do not change task lifetime or make submission retries safe. An ambiguous timeout after POST /v1/task can still mean the task was accepted. Read the API reference for endpoint behavior and the token examples for a complete submission and polling flow.