createTask タスクの作成

createTask は認識タスクを作成します。task.type で、どの種類のキャプチャを認識するかを指定します。非同期タイプは taskId を返すので、その後 getTaskResult で結果を取得します。同期タイプは結果を直接返します。

ノート

タスクの作成に成功した時点で課金されます。タスクを作成するには、残高が 10 ポイントを超えている必要があります。認識に失敗したタスクやタイムアウトしたタスクは自動的に返金されます。

POSThttps://api.yescaptcha.com/createTaskグローバルエンドポイントコピー

POSThttps://cn.yescaptcha.com/createTask中国エンドポイントコピー

リクエストパラメータ

フィールド	型	必須	説明
clientKey	string	はい	アカウントのキー。yescaptcha.com のダッシュボードでコピーします
task	object	はい	タスクオブジェクト。type が必須です。その他のフィールドはタスクタイプに応じて指定します。各タスクタイプのページを参照してください
softID	integer	いいえ	開発者 ID。開発したソフトウェアを他の人が使う場合に指定すると、収益分配を受け取れます。開発者収益分配 を参照してください

リクエスト例

画像キャプチャを認識する（同期）:

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

reCAPTCHA v2 の token を取得する（非同期）:

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

各タスクタイプの task フィールドは、タスクタイプと料金 配下の各ページを参照してください。

レスポンス

非同期タイプ:

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

taskId を控えておき、5 秒後から getTaskResult で問い合わせを始めます。

同期タイプ:

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

失敗:

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

検証の順序

サーバーは次の順序でリクエストを検証し、最初に見つかった問題に対応するエラーコードを返します。この場合、課金されません。

1. リクエストボディが正しい JSON である: ERROR_REQUEST_FORMATS
2. clientKey が含まれている: ERROR_REQUIRED_FIELDS
3. clientKey が存在する: ERROR_KEY_DOES_NOT_EXIST
4. 自動一時停止されていない: ERROR_IP_BLOCKED_5MIN（同時実行数の上限と自動一時停止 を参照）
5. 残高が 10 ポイントを超えている: ERROR_ZERO_BALANCE
6. task が含まれている: ERROR_TASK_ABSENT
7. task.type が存在する: ERROR_TASK_NOT_SUPPORTED
8. 必須フィールドがすべて揃っている: ERROR_REQUIRED_FIELDS（不足しているフィールドは errorDescription に記載されます）
9. 画像系タスクの画像が正しい: ERROR_ZERO_CAPTCHA_FILESIZE、ERROR_IMAGE_TYPE_NOT_SUPPORTED など

完全な例

タスクを作成して結果をポーリングする（非同期タイプ）:

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