Быстрый старт

На этой странице первый запрос отправляется с самым простым типом задачи ImageToTextTaskOcrBase, который распознаёт английские буквы и цифры на картинке. Он синхронный: один запрос createTask сразу возвращает результат. Стоимость — 2 pts (≈ $0.30 / 1k) за запрос, сторонние сайты не нужны, поэтому это удобный способ проверить, что аккаунт и код работают.

1. Зарегистрируйте аккаунт

   Откройте yescaptcha.com, зарегистрируйтесь и войдите.

2. Скопируйте clientKey

   После входа в Панели (yescaptcha.com/dashboard.html) найдите «Ваш ClientKey» и нажмите «копировать». Копируйте значение полностью.

   Осторожно

   Все API-запросы авторизуются по clientKey: кто получил его, тот может тратить ваш баланс. Не передавайте его другим и не добавляйте в публичный код; если ключ утёк, его можно сбросить там же.

3. Пополните баланс

   Чтобы создавать задачи, баланс должен быть больше 10 баллов. Способы пополнения и бонусы VIP: Пополнение и VIP.

4. Проверьте, что clientKey работает

   getBalance возвращает баланс и не списывает баллы:

   curl -s https://api.yescaptcha.com/getBalance \
     -H 'Content-Type: application/json' \
     -d '{"clientKey": "YOUR_CLIENT_KEY"}'

   Ответ {"errorId": 0, "balance": 12345, ...} означает, что всё работает; balance — оставшиеся баллы. Если вернулся ERROR_KEY_DOES_NOT_EXIST, ключ скопирован неверно.

5. Распознайте картинку

   Скачайте пример изображения captcha.jpg (можно взять свою картинку с капчей), задайте clientKey в переменной окружения и запустите скрипт:

   export YESCAPTCHA_CLIENT_KEY=your_client_key

   curl

   quickstart.sh

   #!/usr/bin/env bash
   # First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase (synchronous, 2 points per image)
   # Usage: YESCAPTCHA_CLIENT_KEY=your_client_key bash quickstart.sh captcha.png
   set -euo pipefail
   IMAGE="${1:-captcha.png}"
   BODY=$(base64 < "$IMAGE" | tr -d '\n')   # no "data:" prefix, no line breaks
   curl -s https://api.yescaptcha.com/createTask \
     -H 'Content-Type: application/json' \
     -d "{\"clientKey\": \"${YESCAPTCHA_CLIENT_KEY}\", \"task\": {\"type\": \"ImageToTextTaskOcrBase\", \"body\": \"${BODY}\"}}"
   echo

   Python

   quickstart.py

   """First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase
   (synchronous, 2 points per image).
   
   Usage:
       export YESCAPTCHA_CLIENT_KEY=your_client_key
       python quickstart.py captcha.png
   """
   import base64
   import os
   import sys
   
   import requests
   
   CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"]
   image_path = sys.argv[1] if len(sys.argv) > 1 else "captcha.png"
   
   with open(image_path, "rb") as f:
       body = base64.b64encode(f.read()).decode()  # no "data:" prefix
   
   r = requests.post(
       "https://api.yescaptcha.com/createTask",
       json={
           "clientKey": CLIENT_KEY,
           "task": {"type": "ImageToTextTaskOcrBase", "body": body},
       },
       timeout=30,
   )
   data = r.json()
   if data.get("errorId"):
       raise SystemExit(f"{data.get('errorCode')}: {data.get('errorDescription')}")
   print("text:", data["solution"]["text"])

   Node.js

   quickstart.mjs

   // First request: read an alphanumeric image captcha with ImageToTextTaskOcrBase (synchronous, 2 points per image).
   // Usage: YESCAPTCHA_CLIENT_KEY=your_client_key node quickstart.mjs captcha.png
   import { readFileSync } from 'node:fs';
   
   const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY;
   const body = readFileSync(process.argv[2] ?? 'captcha.png').toString('base64'); // no "data:" prefix
   
   const res = await fetch('https://api.yescaptcha.com/createTask', {
     method: 'POST',
     headers: { 'Content-Type': 'application/json' },
     body: JSON.stringify({ clientKey: CLIENT_KEY, task: { type: 'ImageToTextTaskOcrBase', body } }),
   });
   const data = await res.json();
   if (data.errorId) throw new Error(`${data.errorCode}: ${data.errorDescription}`);
   console.log('text:', data.solution.text);

   Запуск: bash quickstart.sh captcha.jpg, python quickstart.py captcha.jpg или node quickstart.mjs captcha.jpg. Для Python сначала выполните pip install requests; для Node.js нужна версия 18 или новее.

6. Посмотрите результат

   При успехе вернётся:

   {
     "errorId": 0,
     "status": "ready",
     "solution": {
       "text": "LMResm"
     },
     "taskId": "2376919c-1863-11ec-a012-94e6f7355a0b"
   }

   errorId равен 0 — запрос успешен, распознанный текст находится в solution.text. Если errorId равен 1, смотрите errorCode; значения описаны в разделе Коды ошибок.

Что дальше

• Задачи, возвращающие токен (reCAPTCHA, hCaptcha), асинхронные: createTask сначала возвращает taskId, затем нужно вызывать getTaskResult каждые 5 секунд. Полный процесс описан в разделе Запросы и ответы, пример — reCAPTCHA v2.
• Выбор типа задачи: Типы задач и цены.
• Готовый клиент, который можно скопировать в проект: Python, Node.js.
• Без кода: расширение браузера.