GetTaskResultResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/capmonster/json-schema/capmonster-get-task-result-response-schema.json",
  "title": "GetTaskResultResponse",
  "description": "Polling response. Field presence varies by state:\n`processing` returns only `{ \"status\": \"processing\" }`; a successful result returns\n`errorId`, `status: ready` and `solution`; an error returns `errorId`/`errorCode`\n(no `status`). Hence no field is universally required.\n",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/capmonster-openapi.json#/components/schemas/GetTaskResultResponse",
  "type": "object",
  "properties": {
    "errorId": {
      "type": "integer",
      "description": "`0` = success, non-zero = error."
    },
    "errorCode": {
      "oneOf": [
        {
          "$ref": "#/$defs/ErrorCode"
        },
        {
          "type": "null"
        }
      ]
    },
    "errorDescription": {
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "type": "string",
      "description": "`processing` — still being solved (no `solution` yet).\n`ready` — solved, `solution` is present.\n",
      "enum": [
        "processing",
        "ready"
      ]
    },
    "solution": {
      "$ref": "#/$defs/Solution"
    },
    "cost": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cost charged for the task (string-encoded decimal), when available."
    }
  },
  "$defs": {
    "AlibabaSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "data": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "tokens": {
              "type": "string",
              "description": "JSON string with sceneId/certifyId/deviceToken/data."
            }
          }
        }
      },
      "title": "AlibabaSolution"
    },
    "AltchaSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "data": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "token": {
              "type": "string",
              "description": "Base64-encoded solution token."
            },
            "number": {
              "type": "integer"
            }
          }
        }
      },
      "title": "AltchaSolution"
    },
    "AmazonSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "cookies": {
          "type": "object",
          "additionalProperties": true,
          "description": "Cookies to set (e.g. aws-waf-token)."
        },
        "userAgent": {
          "type": "string",
          "description": "User-Agent used while solving."
        }
      },
      "required": [
        "cookies"
      ],
      "title": "AmazonSolution"
    },
    "BasiliskSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "data": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "captcha_response": {
              "type": "string"
            }
          }
        },
        "headers": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "User-Agent": {
              "type": "string"
            }
          }
        }
      },
      "title": "BasiliskSolution"
    },
    "ErrorCode": {
      "type": "string",
      "description": "Machine-readable error code returned when `errorId` is non-zero.",
      "enum": [
        "ERROR_KEY_DOES_NOT_EXIST",
        "ERROR_ZERO_BALANCE",
        "ERROR_TOO_BIG_CAPTCHA_FILESIZE",
        "ERROR_ZERO_CAPTCHA_FILESIZE",
        "ERROR_NO_SUCH_CAPCHA_ID",
        "WRONG_CAPTCHA_ID",
        "ERROR_CAPTCHA_UNSOLVABLE",
        "CAPTCHA_NOT_READY",
        "ERROR_IP_NOT_ALLOWED",
        "ERROR_IP_BANNED",
        "ERROR_NO_SUCH_METHOD",
        "ERROR_TOO_MUCH_REQUESTS",
        "ERROR_DOMAIN_NOT_ALLOWED",
        "ERROR_TOKEN_EXPIRED",
        "ERROR_NO_SLOT_AVAILABLE",
        "ERROR_RECAPTCHA_INVALID_SITEKEY",
        "ERROR_RECAPTCHA_INVALID_DOMAIN",
        "ERROR_RECAPTCHA_TIMEOUT",
        "ERROR_IP_BLOCKED",
        "ERROR_PROXY_CONNECT_REFUSED",
        "ERROR_PROXY_BANNED",
        "ERROR_PROXY_MISSING",
        "ERROR_PROXY_NOT_AUTHORISED",
        "ERROR_PROXY_READ_TIMEOUT",
        "ERROR_TASK_NOT_SUPPORTED",
        "ERROR_TASK_ABSENT",
        "ERROR_WRONG_USERAGENT"
      ]
    },
    "GeeTestSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "challenge": {
          "type": "string",
          "description": "GeeTest v3."
        },
        "validate": {
          "type": "string",
          "description": "GeeTest v3."
        },
        "seccode": {
          "type": "string",
          "description": "GeeTest v3."
        },
        "captcha_id": {
          "type": "string",
          "description": "GeeTest v4."
        },
        "lot_number": {
          "type": "string",
          "description": "GeeTest v4."
        },
        "pass_token": {
          "type": "string",
          "description": "GeeTest v4."
        },
        "gen_time": {
          "type": "string",
          "description": "GeeTest v4."
        },
        "captcha_output": {
          "type": "string",
          "description": "GeeTest v4."
        }
      },
      "title": "GeeTestSolution",
      "description": "GeeTest v3 returns challenge/validate/seccode; v4 returns captcha_id/lot_number/pass_token/gen_time/captcha_output."
    },
    "Solution": {
      "description": "Task answer for `getTaskResult`. The shape depends on the solved captcha type — `getTaskResult`\ndoes not echo the type, so this is an `anyOf` of the per-type solutions plus a permissive fallback.\n",
      "anyOf": [
        {
          "$ref": "#/$defs/textSolution"
        },
        {
          "$ref": "#/$defs/answerSolution"
        },
        {
          "$ref": "#/$defs/gRecaptchaResponseSolution"
        },
        {
          "$ref": "#/$defs/gRecaptchaResponseUserAgentSolution"
        },
        {
          "$ref": "#/$defs/gRecaptchaResponseUserAgentCookiesSolution"
        },
        {
          "$ref": "#/$defs/tokenSolution"
        },
        {
          "$ref": "#/$defs/tokenUserAgentSolution"
        },
        {
          "$ref": "#/$defs/domainsSolution"
        },
        {
          "$ref": "#/$defs/dataTokenSolution"
        },
        {
          "$ref": "#/$defs/GeeTestSolution"
        },
        {
          "$ref": "#/$defs/TurnstileSolution"
        },
        {
          "$ref": "#/$defs/AmazonSolution"
        },
        {
          "$ref": "#/$defs/BasiliskSolution"
        },
        {
          "$ref": "#/$defs/TenDISolution"
        },
        {
          "$ref": "#/$defs/AltchaSolution"
        },
        {
          "$ref": "#/$defs/TspdSolution"
        },
        {
          "$ref": "#/$defs/AlibabaSolution"
        },
        {
          "type": "object",
          "title": "Other / unspecified",
          "description": "Fallback for solution shapes not enumerated above.",
          "additionalProperties": true
        }
      ]
    },
    "TenDISolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "data": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "randstr": {
              "type": "string"
            },
            "ticket": {
              "type": "string"
            }
          }
        },
        "headers": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "User-Agent": {
              "type": "string"
            }
          }
        }
      },
      "title": "TenDISolution"
    },
    "TspdSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "Domains": {
          "type": "object",
          "additionalProperties": true,
          "description": "Per-domain cookies (note: capitalised Domains/Cookies keys for this type)."
        }
      },
      "required": [
        "Domains"
      ],
      "title": "TspdSolution"
    },
    "TurnstileSolution": {
      "title": "TurnstileSolution",
      "allOf": [
        {
          "$ref": "#/$defs/tokenUserAgentSolution"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "cf_clearance": {
              "type": "string",
              "description": "Cloudflare clearance cookie (cf_clearance / wait_room modes)."
            }
          }
        }
      ],
      "description": "token mode returns token (+userAgent); cf_clearance / wait_room modes return cf_clearance."
    },
    "answerSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "answer": {
          "description": "boolean[] (Grid / recaptcha) | number[] (NumericArray) | [{X,Y}] (Coordinate) | string (Text).",
          "oneOf": [
            {
              "type": "array",
              "items": {
                "type": "boolean"
              }
            },
            {
              "type": "array",
              "items": {
                "type": "number"
              }
            },
            {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true,
                "properties": {
                  "X": {
                    "type": "number"
                  },
                  "Y": {
                    "type": "number"
                  }
                }
              }
            },
            {
              "type": "string"
            }
          ]
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "AnswerType": {
              "type": "string",
              "enum": [
                "Text",
                "Coordinate",
                "Grid",
                "NumericArray"
              ]
            }
          }
        }
      },
      "required": [
        "answer"
      ],
      "title": "answerSolution",
      "description": "ComplexImage result. `answer` shape depends on `metadata.AnswerType` (recognition) or is a boolean grid (recaptcha)."
    },
    "dataTokenSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "data": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "token": {
              "type": "string",
              "description": "Solution token (nested under data)."
            }
          }
        }
      },
      "title": "dataTokenSolution"
    },
    "domainsSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "domains": {
          "type": "object",
          "additionalProperties": true,
          "description": "Per-domain cookies/localStorage to apply in the browser."
        }
      },
      "required": [
        "domains"
      ],
      "title": "domainsSolution"
    },
    "gRecaptchaResponseSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "gRecaptchaResponse": {
          "type": "string",
          "description": "Token for the g-recaptcha-response field (~500–2190 bytes)."
        }
      },
      "required": [
        "gRecaptchaResponse"
      ],
      "title": "gRecaptchaResponseSolution"
    },
    "gRecaptchaResponseUserAgentCookiesSolution": {
      "title": "gRecaptchaResponseUserAgentCookiesSolution",
      "allOf": [
        {
          "$ref": "#/$defs/gRecaptchaResponseUserAgentSolution"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "cookies": {
              "type": "object",
              "additionalProperties": true,
              "description": "Additional cookies, when returned."
            }
          }
        }
      ]
    },
    "gRecaptchaResponseUserAgentSolution": {
      "title": "gRecaptchaResponseUserAgentSolution",
      "allOf": [
        {
          "$ref": "#/$defs/gRecaptchaResponseSolution"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "userAgent": {
              "type": "string",
              "description": "User-Agent to resubmit with the token, when returned."
            }
          }
        }
      ]
    },
    "textSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "text": {
          "type": "string",
          "description": "Recognised text."
        }
      },
      "required": [
        "text"
      ],
      "title": "textSolution"
    },
    "tokenSolution": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "token": {
          "type": "string",
          "description": "Solution token."
        }
      },
      "required": [
        "token"
      ],
      "title": "tokenSolution"
    },
    "tokenUserAgentSolution": {
      "title": "tokenUserAgentSolution",
      "allOf": [
        {
          "$ref": "#/$defs/tokenSolution"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "userAgent": {
              "type": "string",
              "description": "User-Agent used while solving."
            }
          }
        }
      ]
    }
  }
}