getTaskResult

Get the task result

#Description

After creating a task, poll its status periodically. Poll no more often than once every 2–3 seconds. A task is stored for 5 minutes after creation, and you must retrieve the result within that time.

Method URL

POSThttps://api.tokenwave.org/getTaskResult

Request format: JSON POST

#Request parameters

clientKeystringrequired

Your API key. You can get the result only for a task created with the same key.

taskIdintegerrequired

The identifier from the createTask response (an integer).
Example: 7654321

#Request example

curl -X POST https://api.tokenwave.org/getTaskResult \
  -H "Content-Type: application/json" \
  -d '{"clientKey": "YOUR_API_KEY", "taskId": 7654321}'

import requests

res = requests.post("https://api.tokenwave.org/getTaskResult", json={
    "clientKey": "YOUR_API_KEY",
    "taskId": 7654321,
}).json()
print(res["status"])

const res = await fetch("https://api.tokenwave.org/getTaskResult", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ clientKey: "YOUR_API_KEY", taskId: 7654321 }),
}).then((r) => r.json());
console.log(res.status);

#Response structure

errorIdinteger

The error flag. 0 — no error, the task state is in status. 1 — an error, its code is in errorCode.

errorCodestring

The error code, for example ERROR_CAPTCHA_UNSOLVABLE. Present only when errorId is 1. All codes are listed in the Error codes section.

statusstring

processing — the task is being solved, request the result later; ready — the solution is ready and is in solution. If it could not be solved, you get the ERROR_CAPTCHA_UNSOLVABLE error.

solutionobject

The solution, present only when status is ready. For hCaptcha: gRecaptchaResponse — the token for the Steam request (single-use, valid for 60 seconds) and userAgent — the User-Agent the captcha was solved with; if it is returned, use it; respKey — the hcaptcha.getRespKey() value, if present (usually absent for Steam pages). More in the HCaptchaTask section.

coststring

The price of the solved task in dollars, a string with six decimal places. Present only when status is ready.
Example: 0.004000

#Response example

Task in progress:

json

{ "errorId": 0, "status": "processing" }

Solution ready:

json

{
  "errorId": 0,
  "status": "ready",
  "solution": {
    "gRecaptchaResponse": "P1_eyJ0eXAiOiJKV1Qi…",
    "respKey": "E0_eyJ0eXAiOiJKV1Qi…",
    "userAgent": "Mozilla/5.0 …"
  },
  "cost": "0.004000"
}

Not solved (you are not charged for the task):

json

{
  "errorId": 1,
  "errorCode": "ERROR_CAPTCHA_UNSOLVABLE",
  "errorDescription": "The captcha could not be solved. This is usually a temporary condition, try again."
}