Endpoints

The YesCaptcha API has two endpoints with identical methods and parameters. Pick the one closer to your servers:

Endpoint	Address	Use it for
Global	https://api.yescaptcha.com	Servers outside mainland China
China	https://cn.yescaptcha.com	Servers in mainland China

A method URL is the endpoint plus the method name, for example creating a task:

POSThttps://api.yescaptcha.com/createTaskGlobal endpointCopy

POSThttps://cn.yescaptcha.com/createTaskChina endpointCopy

Rules

• HTTPS only.
• Every method except /useragent uses POST with a JSON body and the header Content-Type: application/json. The body must be under 6 MB.
• Authentication is the clientKey in the body; no other headers are needed.
• Query a task with getTaskResult on the same endpoint you created it on. Don’t mix endpoints.

All methods

Method	Purpose	Notes
createTask	Create a task	Synchronous types return the result directly
getTaskResult	Get the task result	Poll every 5 seconds for asynchronous types
getBalance	Get the balance	Free
getSoftID	Get your developer ID	For the developer revenue share
report	Report results	Image recognition types can be refunded
useragent	Get the recommended User-Agent	GET, used with hCaptcha

If you cannot connect, see Connection troubleshooting.