createTask — crear una tarea

createTask crea una tarea de reconocimiento; task.type indica qué captcha resolver. Los tipos asíncronos devuelven un taskId, que después usas con getTaskResult para obtener el resultado; los tipos síncronos devuelven el resultado directamente.

Nota

El cobro de puntos se hace cuando la tarea se crea correctamente, y el saldo debe ser superior a 10 puntos para poder crear una tarea. Las tareas que fallan o expiran reciben un reembolso de puntos automático.

POSThttps://api.yescaptcha.com/createTaskEndpoint globalCopiar

POSThttps://cn.yescaptcha.com/createTaskEndpoint ChinaCopiar

Parámetros de la solicitud

Campo	Tipo	Obligatorio	Descripción
clientKey	string	Sí	Tu ClientKey, cópiala desde el Panel de yescaptcha.com
task	object	Sí	Objeto de la tarea. Debe incluir type; los demás campos dependen del tipo de tarea (consulta la página de cada tipo)
softID	integer	No	ID de desarrollador. Inclúyelo cuando otras personas usen el software que desarrollaste para recibir una participación del desarrollador; consulta Participación del desarrollador

Ejemplos de solicitud

Reconocer un captcha de imagen (síncrono):

{
  "clientKey": "YOUR_CLIENT_KEY",
  "task": {
    "type": "ImageToTextTaskOcrBase",
    "body": "BASE64_IMAGE"
  }
}

Obtener un token de reCAPTCHA v2 (asíncrono):

{
  "clientKey": "YOUR_CLIENT_KEY",
  "task": {
    "type": "NoCaptchaTaskProxyless",
    "websiteURL": "https://www.google.com/recaptcha/api2/demo",
    "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
  }
}

Los campos de task de cada tipo están en las páginas de Tipos de tarea y precios.

Respuesta

Tipos asíncronos:

{
  "errorId": 0,
  "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006"
}

Guarda el taskId y empieza a consultar con getTaskResult 5 segundos después.

Tipos síncronos:

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

Fallo:

{
  "errorId": 1,
  "errorCode": "ERROR_TASK_NOT_SUPPORTED",
  "errorDescription": "任务类型不正确或不受支持"
}

Orden de las comprobaciones

El servidor comprueba la solicitud en este orden y devuelve el código de error del primer problema que encuentra, sin cobro de puntos:

1. El cuerpo es un JSON válido: ERROR_REQUEST_FORMATS
2. Se incluyó clientKey: ERROR_REQUIRED_FIELDS
3. clientKey existe: ERROR_KEY_DOES_NOT_EXIST
4. No está en pausa automática: ERROR_IP_BLOCKED_5MIN (consulta Límite de tareas simultáneas y pausa automática)
5. El saldo es superior a 10 puntos: ERROR_ZERO_BALANCE
6. Se incluyó task: ERROR_TASK_ABSENT
7. task.type existe: ERROR_TASK_NOT_SUPPORTED
8. Están todos los campos obligatorios: ERROR_REQUIRED_FIELDS (errorDescription indica qué campo falta)
9. En las tareas con imagen, la imagen es válida: ERROR_ZERO_CAPTCHA_FILESIZE, ERROR_IMAGE_TYPE_NOT_SUPPORTED, etc.

Ejemplo completo

Crear una tarea y consultar el resultado periódicamente (tipo asíncrono):

curl

curl -s https://api.yescaptcha.com/createTask \
  -H 'Content-Type: application/json' \
  -d '{
  "clientKey": "YOUR_CLIENT_KEY",
  "task": {
    "type": "NoCaptchaTaskProxyless",
    "websiteURL": "https://www.google.com/recaptcha/api2/demo",
    "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
  }
}'

# Returns {"errorId":0,"taskId":"..."}; then poll every 5 seconds:
curl -s https://api.yescaptcha.com/getTaskResult \
  -H 'Content-Type: application/json' \
  -d '{"clientKey": "YOUR_CLIENT_KEY", "taskId": "TASK_ID"}'

Python

solve.py

import os
import time

import requests

API = "https://api.yescaptcha.com"
CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"]  # Read the clientKey from an environment variable


def call(method, payload):
    r = requests.post(f"{API}/{method}", json={"clientKey": CLIENT_KEY, **payload}, timeout=30)
    data = r.json()
    if data.get("errorId"):
        raise RuntimeError(f"{data.get('errorCode')}: {data.get('errorDescription')}")
    return data


def solve(task):
    task_id = call("createTask", {"task": task})["taskId"]
    for _ in range(36):  # Poll every 5 seconds, for up to about 3 minutes
        time.sleep(5)
        result = call("getTaskResult", {"taskId": task_id})
        if result.get("status") == "ready":
            return result["solution"]
    raise TimeoutError(task_id)


solution = solve({
    "type": "NoCaptchaTaskProxyless",
    "websiteURL": "https://www.google.com/recaptcha/api2/demo",
    "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
})
print(solution["gRecaptchaResponse"])

Node.js

solve.mjs

const API = 'https://api.yescaptcha.com';
const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY; // Read the clientKey from an environment variable

async function call(method, payload) {
  const res = await fetch(`${API}/${method}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ clientKey: CLIENT_KEY, ...payload }),
  });
  const data = await res.json();
  if (data.errorId) throw new Error(`${data.errorCode}: ${data.errorDescription}`);
  return data;
}

async function solve(task) {
  const { taskId } = await call('createTask', { task });
  for (let i = 0; i < 36; i++) { // Poll every 5 seconds, for up to about 3 minutes
    await new Promise((r) => setTimeout(r, 5000));
    const result = await call('getTaskResult', { taskId });
    if (result.status === 'ready') return result.solution;
  }
  throw new Error(`timeout: ${taskId}`);
}

const solution = await solve({
  type: "NoCaptchaTaskProxyless",
  websiteURL: "https://www.google.com/recaptcha/api2/demo",
  websiteKey: "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
});
console.log(solution.gRecaptchaResponse);