Skip to content
/
API Quickstart Guide
Last updated

API Quickstart Guide

Welcome to CaptchaAI! This quickstart guide will help you get started with CaptchaAI's CAPTCHA solving API, allowing you to make your first API call and begin exploring the possibilities of CAPTCHA solving.

Solving any CAPTCHA with CaptchaAI involves just a few simple steps, regardless of the CAPTCHA type.

  1. Send your image or CAPTCHA to our server.
  2. Get the ID of your task.
  3. Start a cycle that checks if your task is completed.
  4. Get the result.

Prerequisites: Sign Up and Get Your API Key

  1. Visit the CaptchaAI.com.
  2. Create your account and log in.
  3. Navigate to your Dashboard to retrieve your API key.
  4. Contact our support to get a free trial or purchase a plan.

Your API key is required to authenticate all API requests. Make sure you have threads before continuing to the next step.

Step 1: Send your image or CAPTCHA to our server

Let's start by making a simple request to the CaptchaAI API. Use the following curl command to send a reCAPTCHA v3 solve request to in.php endpoint:

curl -X POST https://ocr.captchaai.com/in.php \
-F "key=YOUR_API_KEY_HERE" \
-F "method=userrecaptcha" \
-F "version=v3" \
-F "googlekey=6LdKlZEpAAAAAAOQjzC2v_d36tWxCl6dWsozdSy9" \
-F "pageurl=https://recaptcha-demo.appspot.com/recaptcha-v3-request-scores.php" \
-F "json=1"

Step 2: Get the Task ID

You will receive a response like this:

{
    "status": 1,
    "request": "0123456789"
}

This response confirms that our OCR server has been successfully received your solve request and started the solving process. This part 0123456789 is the Task ID. Save it as it will be used later to get the CAPTCHA answer.

Step 3: Start a cycle that checks if your task is completed.

Next, We will check the result endpoint every 5 seconds until we get the token.

Polling rate may vary for each CAPTCHA type.

To check the result endpoint res.php for the token, use this curl command:

curl -X POST https://ocr.captchaai.com/res.php \
-F "key=YOUR_API_KEY_HERE" \
-F "action=get" \
-F "id=YOUR_TASK_ID_HERE" \
-F "json=1"

Basic Error handling

Handling CAPCHA_NOT_READY

If you received CAPCHA_NOT_READY, this means that our servers are still processing the task. In this case, simply continue polling every 5 seconds.

Request Example

{
    "status": 0,
    "request": "CAPCHA_NOT_READY"
}

Handling ERROR_CAPTCHA_UNSOLVABLE

In some rare cases, you may receive ERROR_CAPTCHA_UNSOLVABLE, this means that our servers failed to solve the task. In this case review your request format and parameter values and try again

Request Example

{
    "status": 0,
    "request": "ERROR_CAPTCHA_UNSOLVABLE"
}

Step 4: Get the result

You will receive a response like this:

{
    "status": 1,
    "request": "0cAFcWeA5vgLQUZ9NXgDsnDN7NiNl-8i7jNh4W4-bnKv_YlsbSA9GYxMRiONkRdAreUyIYybnwy8DxxxxIufjLwO3iQ13Y0ytpklfwND9SLx1qu1fQPVfkYJoOYg2nxiAf2ogrtsYK_ZytmVD8wGuoUzjEIFxT7eUI1IAji-dmNS2dJQxLv8XhL2GW9S0s-eOAvTq69j1Nu0DMnZU_UMs5qRq1fvaCwj6zHgUvH5H642xUuZMTgDCWEkiCpL_xLIfj06xPFw6NwcI_B7zrhGBax8xNVn5X7rQhB9hVERozRVbXnbNatHrAzKPdTPQH1zodkZbbA7ihHOGKLD5Uq1ODxSZLHJqQPYV1l51_7FeP5RhUsC-sAY4DvPJhR0QGvEVl4gHPHnKtMgD8y87SfV8flKwCmrfCAZNgOzr3q1OH7tyrwkC1XSGtPQw1ZNdzNNXr1oaBUjO_Vi2M4PAioyHffcsmhXbBteIEqD7ASwdxZ8JhBFvnurYhPjQKKGXfYg_pb1RIoWHMO7n891-hxxxJHpSTwqiTkd2VZF4Y09pHNFUgde6VWJotcYsH-YhGRy3uLuEFupe62G9UWJipcc6wgYV421TmNpUA-EN8yM0PnUaU_58mr4so5SFnkptFaYWfUZKN-NTHp1BhUYNVAOhRfkSDLJwi2oYnJuf5wjP7YRE169FqNj6banvQ65v6p-pX2ZLzqUX2PKjPW7O9Xv1Zuku8jXOq387bT7I-pQIg-cFxZzGZ9j7kDsnU2dZfloALF-yUI6TxxkxWU7xfJ6HYx66PRB1EpqaAIOQMAC-BcwXr6xVZzGeNg2d9N09o6qsj_iDoySU8VQsPWfT0l6uTMbAybQFR1If3WSDx2_YorYRtSY3Q5-so2z9u1r_6P4zVjxpFxxt2PVdHqhVBykJgToQ4eXZCZpXafgpTMfd5eKk1yiNc-1pfKBhQ1yzEsmixxxAyZwnoOPOkxxxjiO-kOPDhLY8yWHU_KAhrVvcmwYOwznDLMWExZikx7y2pxzBTYoz4ALa9VOjFNVzGF_IYntQ8pTWm8IDSXkqJ8muyCSvzsylGd3nUomEKAElH85XdBL4-I_AVsuQfLsIg-tJvNCqTPhBWxI0DSMtxH3lQXvXb48J-dUWLYNReHGANlxa0tjLAknIeKMqY9ZCq90XwlTOPr8gYDjB12j5jK90GguXV9narrRw4NHFG0fZ8LK9IkEcPY0oL0T3noQsKWABMYqrHnW2WKItk8J_O2pV6EWG49-m9l0nXtipWX8fLmF02u7Vvh8e1VJ_j8lvBR6aupDdKGRJB36XfaCKtt4cy-sCvQbvn1ekma2yW7TMxhZ9g0OWiJxx7dJgGT3PsA0wRpIX-Ek6W-GD6LLJ509b9TmrdHIT9CIXToYYhi9acJgOM7AMd9xo4PBr13QrBPeHJqmKqZS5fW92EjorXMfbyvZQrUDtju3dozIdubk3vhkNKL3VAgjfsqowc0HnrLxvDVQDLtPuyudHP8HYbDnnojSxxxHT"
}

This is the reCAPTCHA v3 token, you can use it to bypass the reCAPTCHA v3 protection on the target site.

For more info on how to use the token you can visit reCAPTCHA v3 Solving Guide

Congratulations!

You’ve completed your first CAPTCHA defeating mission using the CaptchaAI API! Explore more advanced features in our documentation.

Previous page
Next page