Inicio rápido

Esta página envía una primera solicitud con el tipo de tarea más sencillo, ImageToTextTaskOcrBase, que reconoce las letras y los números de una imagen. Es síncrono: una sola solicitud createTask devuelve el resultado. Cuesta 2 puntos (≈ $0.30 / 1k) por solicitud y no depende de sitios de terceros, así que sirve para comprobar que tu cuenta y tu código funcionan.

1. Crea tu cuenta

   Abre yescaptcha.com, crea tu cuenta e inicia sesión.

2. Copia tu ClientKey

   Una vez dentro, en el Panel (yescaptcha.com/dashboard.html) busca “Tu ClientKey” y haz clic en copiar. Copia el valor completo.

   Precaución

   Todas las solicitudes a la API se autentican con el ClientKey, así que quien lo tenga puede gastar tu saldo. No lo compartas ni lo escribas en código público; si se filtra, puedes restablecerlo en el mismo lugar.

3. Recarga saldo

   El saldo debe ser superior a 10 puntos para poder crear tareas. Los métodos de pago y el bono VIP están en Recarga y VIP.

4. Comprueba que el ClientKey funciona

   getBalance consulta el saldo y no cobra puntos:

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

   Si recibes {"errorId": 0, "balance": 12345, ...}, todo está listo; balance son los puntos restantes. Si recibes ERROR_KEY_DOES_NOT_EXIST, la clave se copió mal.

5. Reconoce una imagen

   Descarga la imagen de ejemplo captcha.jpg (también puedes usar tu propia imagen de captcha), guarda tu ClientKey en una variable de entorno y ejecuta uno de los scripts:

   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);

   Ejecuta bash quickstart.sh captcha.jpg, python quickstart.py captcha.jpg o node quickstart.mjs captcha.jpg. Python requiere pip install requests antes; Node.js requiere la versión 18 o superior.

6. Consulta el resultado

   Si todo va bien, recibes:

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

   errorId igual a 0 indica éxito, y el texto reconocido está en solution.text. Si errorId es 1, revisa errorCode; su significado está en Códigos de error.

Siguientes pasos

• Las tareas que devuelven token, como reCAPTCHA y hCaptcha, son asíncronas: createTask devuelve primero un taskId y después consultas getTaskResult cada 5 segundos. El flujo completo está en Solicitudes y respuestas; un ejemplo es reCAPTCHA v2.
• Elige un tipo de tarea: Tipos de tarea y precios.
• Un cliente que puedes copiar directamente a tu proyecto: Python, Node.js.
• Sin escribir código: extensión del navegador.