> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omocaptcha.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HcaptchaImageTask

> Solve hCaptcha image challenges (grid / canvas click / canvas drag)

hCaptcha — also known as the **I AM NOT A ROBOT** captcha — is one of the most common image-based verification systems.

<Columns cols={3}>
  <Frame caption="Canvas drag — Please drag the pieces to complete the puzzle">
    <img src="https://mintcdn.com/omocaptcha/Jc1mwaiUF23R0W3R/images/hcaptcha-drag.png?fit=max&auto=format&n=Jc1mwaiUF23R0W3R&q=85&s=153e9fdc51e2dd4bf2396cf452cffc7c" alt="hCaptcha drag canvas puzzle" width="516" height="526" data-path="images/hcaptcha-drag.png" />
  </Frame>

  <Frame caption="Grid with anchors — Pick objects that could rest on the surface">
    <img src="https://mintcdn.com/omocaptcha/Jc1mwaiUF23R0W3R/images/hcaptcha-canvas.png?fit=max&auto=format&n=Jc1mwaiUF23R0W3R&q=85&s=adb4aa13db65e2f290bcf7421505336b" alt="hCaptcha grid with anchor images" width="399" height="598" data-path="images/hcaptcha-canvas.png" />
  </Frame>

  <Frame caption="Grid — Pick all the cooking utensils and equipment">
    <img src="https://mintcdn.com/omocaptcha/Jc1mwaiUF23R0W3R/images/hcaptcha-grid.png?fit=max&auto=format&n=Jc1mwaiUF23R0W3R&q=85&s=e6d9faf33c184ce1afd204be8e7a454a" alt="hCaptcha grid challenge" width="515" height="632" data-path="images/hcaptcha-grid.png" />
  </Frame>
</Columns>

## 1. Create task

### Request

```http theme={null}
POST https://api.omocaptcha.com/v2/createTask
Content-Type: application/json
```

#### Body Parameters

| Parameter           | Type           | Required | Description                                                                                                    |
| ------------------- | -------------- | :------: | -------------------------------------------------------------------------------------------------------------- |
| `clientKey`         | `String`       |     ✅    | Your client API key                                                                                            |
| `task.type`         | `String`       |     ✅    | Captcha service class name (`HcaptchaImageTask`)                                                               |
| `task.anchors`      | array\<string> |     ✅    | Array of base64-encoded anchor (header) images (pass `[]` if none)                                             |
| `task.queries`      | array\<string> |     ✅    | Array of base64-encoded challenge images (for **grid**: 9 images in DOM order; for **canvas**: a single image) |
| `task.question`     | `String`       |     ✅    | The challenge question text                                                                                    |
| `task.isScreenshot` | `Boolean`      |     ❌    | Set to `true` when sending a single full screenshot (containing both the question and the challenge)           |

<Tip>
  You can also send a single screenshot that contains both the challenge images and the question — set `isScreenshot: true` and omit `question` / `anchors`.
</Tip>

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.omocaptcha.com/v2/createTask \
    -H "Content-Type: application/json" \
    -d '{
      "clientKey": "OMO_API_KEY",
      "task": {
        "type": "HcaptchaImageTask",
        "anchors": ["base64_image_1", "base64_image_2"],
        "queries": ["base64_image_1", "base64_image_2"],
        "question": "Pick all the cooking utensils and equipment"
      }
    }'
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://api.omocaptcha.com/v2/createTask", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      clientKey: "OMO_API_KEY",
      task: {
        type: "HcaptchaImageTask",
        anchors: ["base64_image_1", "base64_image_2"],
        queries: ["base64_image_1", "base64_image_2"],
        question: "Pick all the cooking utensils and equipment"
      }
    })
  });
  console.log(await res.json());
  ```

  ```python Python theme={null}
  import requests

  res = requests.post(
      "https://api.omocaptcha.com/v2/createTask",
      json={
          "clientKey": "OMO_API_KEY",
          "task": {
              "type": "HcaptchaImageTask",
              "anchors": ["base64_image_1", "base64_image_2"],
              "queries": ["base64_image_1", "base64_image_2"],
              "question": "Pick all the cooking utensils and equipment"
          }
      }
  )
  print(res.json())
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init("https://api.omocaptcha.com/v2/createTask");
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
      "clientKey" => "OMO_API_KEY",
      "task" => [
          "type" => "HcaptchaImageTask",
          "anchors" => ["base64_image_1", "base64_image_2"],
          "queries" => ["base64_image_1", "base64_image_2"],
          "question" => "Pick all the cooking utensils and equipment"
      ]
  ]));
  echo curl_exec($ch);
  ```
</CodeGroup>

Or send a single **screenshot** containing both the challenge and the question:

```json theme={null}
{
  "clientKey": "OMO_API_KEY",
  "task": {
    "type": "HcaptchaImageTask",
    "queries": ["base64_image"],
    "isScreenshot": true
  }
}
```

### Response

<CodeGroup>
  ```json Success theme={null}
  {
    "errorId": 0,
    "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
  }
  ```

  ```json Failure theme={null}
  {
    "errorId": 1,
    "errorCode": "",
    "errorDescription": ""
  }
  ```
</CodeGroup>

* `errorId = 0` and `taskId` → success
* `errorId = 1` and `errorCode` → failure (see [Error Codes](/en/api/error-codes))

## 2. Get task result

### Request

```http theme={null}
POST https://api.omocaptcha.com/v2/getTaskResult
Content-Type: application/json
```

```json theme={null}
{
  "clientKey": "OMO_API_KEY",
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}
```

Depending on the challenge variant, `solution` is returned in one of the three formats below.

### 2a. Grid result

<CodeGroup>
  ```json Success theme={null}
  {
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "status": "ready",
    "solution": {
      "objects": [1, 3, 8]
    }
  }
  ```

  ```json Processing theme={null}
  {
    "status": "processing",
    "errorId": 0,
    "errorCode": "",
    "errorDescription": ""
  }
  ```

  ```json Failure theme={null}
  {
    "errorId": 1,
    "errorCode": "ERROR_JOB_STATUS",
    "errorDescription": "Job failed",
    "status": "fail",
    "solution": {}
  }
  ```
</CodeGroup>

* `solution.objects` → indices of the grid cells to click (DOM order).

### 2b. Canvas click result

<CodeGroup>
  ```json Success theme={null}
  {
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "status": "ready",
    "solution": {
      "type": "click",
      "coords": [
        [398, 347]
      ]
    }
  }
  ```

  ```json Processing theme={null}
  {
    "status": "processing",
    "errorId": 0,
    "errorCode": "",
    "errorDescription": ""
  }
  ```

  ```json Failure theme={null}
  {
    "errorId": 1,
    "errorCode": "ERROR_JOB_STATUS",
    "errorDescription": "Job failed",
    "status": "fail",
    "solution": {}
  }
  ```
</CodeGroup>

* `solution.type = "click"` → each entry in `coords` is an `[x, y]` point to click on the canvas.

### 2c. Canvas drag result

<CodeGroup>
  ```json Success theme={null}
  {
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "status": "ready",
    "solution": {
      "type": "drag",
      "box": [
        { "start": [446, 200], "end": [100, 224] },
        { "start": [455, 300], "end": [139, 190] }
      ]
    }
  }
  ```

  ```json Processing theme={null}
  {
    "status": "processing",
    "errorId": 0,
    "errorCode": "",
    "errorDescription": ""
  }
  ```

  ```json Failure theme={null}
  {
    "errorId": 1,
    "errorCode": "ERROR_JOB_STATUS",
    "errorDescription": "Job failed",
    "status": "fail",
    "solution": {}
  }
  ```
</CodeGroup>

* `solution.type = "drag"` → each entry in `box` has a `start` `[x, y]` and an `end` `[x, y]`, simulating dragging a puzzle piece from `start` to `end`.

<Note>
  Wait **2 seconds** between `getTaskResult` polls while `status = "processing"`.
</Note>