Skip to content

Node.js guide

Solve captchas from Node.js with one function

A small dependency-free helper sends a task, waits for the result and hands you the text or token. No SDK, no extra service, just HTTPS and JSON.

  • Node.js 18+
  • built-in fetch
  • ~70 lines
  • No SDK

Setup

Before you start

  • Node.js 18 or newer (for the built-in fetch and AbortSignal.timeout)
  • No npm packages needed
  • A bypass.so API key (create one) with a positive balance

Install

terminal
mkdir bypass-demo && cd bypass-demo
node --version

Store your key

The examples read your key from the BYPASS_API_KEY environment variable, so it never lands in source control.

Shell
export BYPASS_API_KEY="your-api-key"

Check that the key works: curl -H "Authorization: Bearer $BYPASS_API_KEY" https://bypass.so/balance returns your balance.

Step 1

Add the helper

Save this file next to your code. It wraps the whole task lifecycle in one function, solve(type, params), so the rest of your project never deals with polling.

  • createTask: sends your key, the task type and its fields.
  • Fast path: if the answer is already ready, it returns at once.
  • Polling: otherwise it checks /getTaskResult/{taskId} every two seconds until the result is ready or your timeout runs out.
  • Errors: any errorId: 1 becomes a BypassError carrying the errorCode, so you can branch on it.
  • taskId: added to the returned solution, so you can report a wrong answer later.
bypass.mjs
const API_URL = "https://bypass.so";
const CLIENT_KEY = process.env.BYPASS_API_KEY ?? "";

export class BypassError extends Error {
  constructor(code, description = "", taskId = null) {
    super(`${code}: ${description}`);
    this.name = "BypassError";
    this.code = code;
    this.taskId = taskId;
  }
}

const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function call(path, init = {}) {
  const res = await fetch(API_URL + path, { ...init, signal: AbortSignal.timeout(30_000) });
  let data;
  try {
    data = await res.json();
  } catch {
    throw new BypassError("HTTP_ERROR", `HTTP ${res.status} without a JSON body`);
  }
  if (data.errorId) {
    throw new BypassError(data.errorCode ?? "ERROR_UNKNOWN", data.errorDescription ?? "", data.taskId);
  }
  return data;
}

export async function solve(type, params, { timeoutMs = 120_000, pollMs = 2_000 } = {}) {
  if (!CLIENT_KEY) {
    throw new BypassError("ERROR_KEY_INVALID", "set the BYPASS_API_KEY environment variable");
  }
  let data = await call("/createTask", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ clientKey: CLIENT_KEY, type, ...params }),
  });
  const taskId = data.taskId;
  const deadline = Date.now() + timeoutMs;
  while (data.status !== "ready") {
    if (Date.now() > deadline) {
      throw new BypassError("CLIENT_TIMEOUT", `task ${taskId} was not ready after ${timeoutMs / 1000}s`, taskId);
    }
    await sleep(pollMs);
    data = await call(`/getTaskResult/${taskId}?clientKey=${encodeURIComponent(CLIENT_KEY)}`);
  }
  return { ...data.solution, taskId };
}

export const tokenOf = (solution) => solution.gRecaptchaResponse ?? solution.token ?? solution.text;

export const balance = () =>
  call("/balance", { headers: { Authorization: `Bearer ${CLIENT_KEY}` } });

export const reportBad = (taskId) =>
  call(`/reportBad?task_id=${encodeURIComponent(taskId)}`, {
    method: "POST",
    headers: { Authorization: `Bearer ${CLIENT_KEY}` },
  });

Step 2

Solve any supported type

Every task type uses the same call. Only the type name and its fields change. Pick a tab to see a complete, runnable file. Tabs marked soon are ready for launch day, but those types are not live yet. Run it with node solve-image-to-text.mjs (rename to match the tab).

solve-math.mjs
import { solve } from "./bypass.mjs";

const { text } = await solve("MathCaptchaTask", { captchaText: "12 + 30 = ?" });
console.log(text);

reCAPTCHA v3 and hCaptcha are coming soon

RecaptchaV3Task and HCaptchaTask are not live yet. Until launch, createTask returns ERROR_TASK_NOT_SUPPORTED and nothing is charged. Get notified when they ship.

Token types and your form

For reCAPTCHA, Turnstile and (once live) hCaptcha the token goes into the same form field the widget would fill: g-recaptcha-response, h-captcha-response or cf-turnstile-response. Driving a real page? See the Selenium, Playwright or Puppeteer guides.

Step 3

Handle errors and retries

Some failures are worth a second try and some are not. A missing balance or a wrong key will fail again, so stop and fix it. An unsolvable task or a network hiccup is worth one or two more attempts with a short pause.

retry.mjs
import { BypassError, reportBad, solve } from "./bypass.mjs";

const RETRYABLE = new Set(["ERROR_CAPTCHA_UNSOLVABLE", "ERROR_INTERNAL", "HTTP_ERROR", "CLIENT_TIMEOUT"]);

export async function solveWithRetry(type, params, attempts = 3) {
  for (let attempt = 1; ; attempt++) {
    try {
      return await solve(type, params);
    } catch (err) {
      const retryable = err instanceof BypassError ? RETRYABLE.has(err.code) : err.name === "TimeoutError" || err.name === "TypeError"; // fetch rejects with TypeError on network failures
      if (!retryable || attempt >= attempts) throw err;
      console.warn(`attempt ${attempt} failed (${err.code ?? err.name}), retrying`);
      await new Promise((r) => setTimeout(r, 2_000 * attempt));
    }
  }
}

const solution = await solveWithRetry("MathCaptchaTask", { captchaText: "12 + 30 = ?" });
console.log(solution.text);

Failed tasks cost nothing

The task price is held when you create a task and released if it fails. You are only charged when the result is ready.

Step 4

Check your balance and flag wrong answers

GET /balance and POST /reportBad use your key as a Bearer token. Report a task only when the target site actually rejected its answer. The refund is applied once per task, and the task is closed afterwards.

account.mjs
import { balance, reportBad } from "./bypass.mjs";

export async function flagWrongAnswer(solution) {
  const { refunded, balanceUsd } = await reportBad(solution.taskId);
  console.log("refunded units:", refunded, "balance now:", balanceUsd);
}

const { balanceUsd } = await balance();
console.log(`balance: $${balanceUsd.toFixed(2)}`);

Scale

Solve many tasks in parallel

Each task is independent, so throughput grows with concurrency. A small pool of concurrent lanes keeps a fixed number of tasks in flight without any extra package. Start with a limit of 8 and adjust while you watch error rates and spend.

batch.mjs
import { readdir, readFile } from "node:fs/promises";
import { solve } from "./bypass.mjs";

async function mapLimit(items, limit, fn) {
  const results = new Array(items.length);
  let next = 0;
  const lanes = Array.from({ length: limit }, async () => {
    while (next < items.length) {
      const i = next++;
      results[i] = await fn(items[i]).catch((err) => ({ error: err.message }));
    }
  });
  await Promise.all(lanes);
  return results;
}

const files = (await readdir("captchas")).filter((f) => f.endsWith(".png"));
const results = await mapLimit(files, 8, async (name) => {
  const imageBase64 = (await readFile(`captchas/${name}`)).toString("base64");
  const { text } = await solve("ImageToTextTask", { imageBase64 });
  return { name, text };
});
console.table(results);

Reference

Task type reference

What each type expects and returns. Prices are per 1,000 solved tasks; larger top-ups add bonus credit (see pricing).

Task type reference
Task typeMathCaptchaTaskYou sendcaptchaTextYou gettextPrice / 1k$0.35
Task typeImageToTextTaskYou sendimageBase64You gettextPrice / 1k$0.28
Task typeAudioCaptchaTaskYou sendaudioBase64You gettextPrice / 1k$0.35
Task typeRecaptchaV2TaskYou sendwebsiteURLwebsiteKeyYou getgRecaptchaResponse and token, plus tokenFieldPrice / 1k$0.56
Task typeTurnstileTaskYou sendwebsiteURLwebsiteKeyYou gettoken, plus tokenFieldPrice / 1k$0.84
Task typeRecaptchaV3TaskComing soonYou sendwebsiteURLwebsiteKeyactionYou getgRecaptchaResponse and token, plus tokenFieldPrice / 1kAt launch
Task typeHCaptchaTaskComing soonYou sendwebsiteURLwebsiteKeyYou gettoken, plus tokenFieldPrice / 1kAt launch

Errors

Troubleshooting

Errors and fixes
ErrorERROR_KEY_INVALIDSourceHTTP 403What it meansThe key is missing, mistyped or revoked.How to fix itCheck that BYPASS_API_KEY is set in the same shell that runs your code, with no quotes or spaces around it.
ErrorERROR_INSUFFICIENT_CREDITSSourceHTTP 402What it meansYour balance cannot cover the task price.How to fix itTop up from the dashboard. Nothing was charged for this request.
ErrorERROR_TASK_NOT_SUPPORTEDSourceHTTP 200What it meansThe type string is unknown, or the type is still coming soon (reCAPTCHA v3, hCaptcha).How to fix itCopy the exact name, for example TurnstileTask. Names are case-sensitive. Nothing is charged.
ErrorERROR_BAD_REQUESTSourceHTTP 400What it meansThe body is not valid JSON, or a field has the wrong type.How to fix itSend Content-Type: application/json and string values for clientKey, type and the task fields.
ErrorERROR_CAPTCHA_UNSOLVABLESourceHTTP 200What it meansThis task could not be completed.How to fix itYou are not charged. Check the image, sitekey and page URL, then submit a new task.
ErrorERROR_NOT_FOUNDSourceHTTP 404What it meansThe taskId is unknown or belongs to another key.How to fix itPoll with the taskId returned by your own createTask call, using the same key.
ErrorERROR_INTERNALSourceHTTP 500What it meansSomething went wrong on our side.How to fix itRetry after a short pause. The helper’s retry wrapper does this for you.
ErrorHelper timeoutSourceyour codeWhat it meansNo result inside your timeout.How to fix itToken types usually need several seconds. Keep at least 60–120 s and retry with a new task.
ErrorHTTP_ERRORSourceyour codeWhat it meansA proxy or network layer answered without JSON.How to fix itRetry with backoff. If it persists, check that your code calls https://bypass.so.

Every error body has the same shape: {"errorId":1,"errorCode":"…","errorDescription":"…"}. Full list in the API reference.

Production

Best practices

  • Keep the key out of code

    Read it from an environment variable or your secret store. Never commit it or ship it to a web page.

  • Solve right before submit

    Tokens are short-lived. Fill the form first, then request the token and submit at once.

  • Cap your concurrency

    Start with 5–10 parallel tasks and raise it while you watch error rates and spend.

  • Log every taskId

    It is the only thing you need to debug a result or report a wrong answer.

  • Match the page exactly

    Send the URL where the widget renders and the sitekey from that page, not from a different form.

  • Report wrong answers

    If a site rejects a solved result, call reportBad with its taskId. The price returns to your balance once.

FAQ

Questions

No. The API is two HTTPS endpoints that take and return JSON. The helper on this page is about sixty lines that you own, can read in a minute and can change freely.

Math, image and audio tasks often finish while the createTask request is still open. The response then already has "status": "ready" and a solution, so the helper returns without polling. Token types always come back as processing first.

Every two seconds is a good default. Polling faster does not make a task finish sooner. Keep the overall timeout at 60 to 120 seconds for token types.

No. You pay only when a task comes back ready. If a site rejects a solved answer, call reportBad with its taskId and the price returns to your balance once. A reported task is closed, so submit a new one to try again.

Yes. The flow is the same two calls. In Python, swap requests for an async HTTP client and time.sleep for asyncio.sleep. In Node.js, any client works as long as you parse the JSON body on error status codes too.

Policy

Responsible use

Use it where you are allowed to

Automate pages you own, test environments you run, or sites whose terms permit automated access. Do not use bypass.so for fraud, account takeover, spam, scalping, evading bans or collecting personal data without a lawful basis. Keep request rates reasonable and stop when a site asks you to. Our acceptable use policy applies to every key, and keys used for abuse are closed.

Keep going

Next steps