API documentation

Welcome to our CAPTCHA recognition service. This document will help you quickly integrate our API.

Basic Information

API Address：/api/solve/{type}
Request method：POST / GET
Return format：JSON

Integration Steps

Obtain your API key from your secrets settings.
Choose the appropriate CAPTCHA type and send a request to the corresponding API endpoint.
Receive the response, extract the order ID, and retrieve the results via the query results endpoint.
Use the recognized result to complete the verification process on the target website.

verify

All API requests must include your API key. You can obtain your API key in your secrets settings.

Request Example

curl -X POST -H "Authorization: Bearer Api_key" -d "image=data:image/jpeg;base64,xxxxxxx" -d "min_length=6" -d "max_length=1" -d "tips_message=message content" -d "case_sensitive=true" {$host}/api/solve/image_text

Response Example

{ "success": true, "code": 0, "message": "Order created successfully", "data": { "order_no": "fed9c0c1-7b90-44dc-9b55-229b4e6a5e46" } }

Image Captcha

It can recognize traditional image CAPTCHAs and supports multiple types such as numbers, letters, and Chinese characters.

image_text

Note For CAPTCHAs with complex backgrounds or low contrast, it is recommended to use the "tips_message" parameter to provide additional hints for better recognition results.

Request parameters

parameter	type	Required	explanation
image	string	yes	Base64 encoded image data
min_length	integer	no	The minimum expected length of the verification code, which defaults to 1.
max_length	integer	no	The maximum expected length of the verification code is 10 bytes by default.
tips_message	string	no	Identify prompts and provide additional clues for difficult-to-recognize CAPTCHAs.
case_sensitive	bool	no	Whether to distinguish between uppercase and lowercase letters; the default value is false (not case-sensitive).

Math Captcha

Recognize mathematical expression CAPTCHAs and return the calculation result.

image-math

Request parameters

parameter	type	Required	explanation
image	string	yes	Base64 encoded image data

reCAPTCHA v2

Recognize Google's reCAPTCHA v2 and return the token for verification.

recaptcha_v2

Request parameters

parameter	type	Required	explanation
url	string	yes	The full URL of target web page where the captcha is loaded.
site_key	string	yes	The site key of the reCAPTCHA, which can be found in the page source code.
is_invisible	bool	no	Whether it is an invisible reCAPTCHA; the default value is false.

reCAPTCHA v3

Recognize Google's reCAPTCHA v3 and return the token for verification.

recaptcha_v3

Request parameters

parameter	type	Required	explanation
url	string	yes	The full URL of target web page where the captcha is loaded.
site_key	string	yes	The site key of the reCAPTCHA, which can be found in the page source code.
min_score	float	yes	The minimum score threshold for reCAPTCHA v3, which defaults to 0.5.
page_action	string	no	The page action for reCAPTCHA v3, which can be used to provide additional context for the CAPTCHA.
is_enterprise	bool	no	Whether it is reCAPTCHA Enterprise; the default value is false.
load_domain	string	no	The domain to load the reCAPTCHA API from, which defaults to "www.google.com".

GeeTest

Recognize GeeTest CAPTCHA and return the token for verification.

gee_test

Request parameters

parameter	type	Required	explanation
url	string	yes	The full URL of target web page where the captcha is loaded.
gt	string	yes	The "gt" parameter for GeeTest, which can be found in the page source code.
challenge	string	yes	The "challenge" parameter for GeeTest, which can be found in the page source code.

Turnstile

Recognize Cloudflare's Turnstile CAPTCHA and return the token for verification.

turnstile

Request parameters

parameter	type	Required	explanation
url	string	yes	The full URL of target web page where the captcha is loaded.
site_key	string	yes	The site key of the Turnstile CAPTCHA, which can be found in the page source code.

Click Captcha

Recognize image click CAPTCHAs and return the coordinates of the click points.

image_click

Request parameters

parameter	type	Required	explanation
image	string	yes	Base64 encoded image data
tips_image	string	yes	Base64 encoded image data for tips, which can be used to provide additional clues for difficult-to-recognize CAPTCHAs.
tips_message	string	yes	Identify prompts and provide additional clues for difficult-to-recognize CAPTCHAs.

Number Captcha

Recognize number CAPTCHAs and return the recognized digits.

image_number

Request parameters

parameter	type	Required	explanation
image	string	yes	Base64 encoded image data
tips_message	string	yes	Identify prompts and provide additional clues for difficult-to-recognize CAPTCHAs.

Rotate Captcha

Recognize rotate CAPTCHAs and return the correct orientation.

rotate_captcha

Request parameters

parameter	type	Required	explanation
image	string	yes	Base64 encoded image data
angle	integer	no	The angle of rotation for the CAPTCHA, which can be used to provide additional context for the recognition.
tips_message	string	yes	Identify prompts and provide additional clues for difficult-to-recognize CAPTCHAs.
tips_image	string	yes	Base64 encoded image data for tips, which can be used to provide additional clues for difficult-to-recognize CAPTCHAs.

Query Result

Query the identification results by task ID.

Request Example

curl -X POST -H "Authorization: Bearer Api_key" -d "order_no={order}" {$host}/api/solve/result

Response Example

{ "success": true, "code": 0, "message": "Query successful", "data": { "status": "success", "order_no": "xxxx-xxxx-xxxx-xxxx", "result": "AB12CD", "cost": 0.001 } }

Query Balance

Check your account's current balance.

Request Example

curl -X POST -H "Authorization: Bearer Api_key" {$host}/api/solve/balance

Response Example

{ "success": true, "code": 0, "message": "Query successful", "data": { "balance": "49.84800" } }

Error code

When an error occurs, the API will return a non-zero error code along with a message describing the error. The following table lists the common error codes and their explanations.

Response Example

{ "success": false, "code": 400, "message": "Incorrect request parameters" }

code	explanation
400	Incorrect request parameters
401	Unauthorized, invalid API key
402	Insufficient balance
429	Too many requests
500	Internal server error