Skip to Main Content
HTTP API

Bypass and Unlock Over HTTP

Call the engine base URL with your license key. Unlock returns JSON (or NDJSON when you stream). Check balance on GET /license. List live provider costs on GET /pricing.

POST/bypassGET/licenseGET/pricing
Setup

Quickstart

Three steps before your first unlock call. The same key and credit wallet work across every Bypass Lab surface.

  1. 01

    Get a License

    Buy a Bypass Lab license on Telegram or Discord. The same key works for website, Chrome extension, Telegram bot, and HTTP API.

  2. 02

    Buy Credits

    Top up tokens so the key has balance. 5,000 tokens for $5. Credits charge only after a successful unlock.

  3. 03

    Call POST /bypass

    Send X-License-Key (or Authorization Bearer) and JSON {"url":"<full https link>"}. Read destination and creditsCharged from the response.

Credentials

Authentication

Every unlock and license read needs your Bypass Lab license key. Pricing is public and does not require a key.

Replace YOUR_LICENSE_KEY with your Bypass Lab license. You can also send Authorization: Bearer YOUR_LICENSE_KEY. Optional: send X-Request-Id (for example a UUID) when you retry the same unlock so billing stays idempotent.

Base URL
https://bypasslab-engine.edge-workspace.workers.dev
License Headers
X-License-Key: YOUR_LICENSE_KEY
Content-Type: application/json

X-License-Key

Preferred header. Authenticates the request and selects your credit wallet.

Authorization Bearer

Same key value as Bearer token. Do not mix this with engine service keys.

X-Request-Id

Optional idempotency key for unlock billing. Reusing the same id after a successful debit does not charge again.

Unlock

POST /bypass

Unlock a supported http or https URL. JSON mode returns one object. Stream mode emits NDJSON events until done, password, or error.

POST/bypassLicense required

Request Body

  • url
    stringRequired

    Full http or https link to unlock.

  • password
    stringOptional

    Link password when the host paused for one on a prior call.

  • stream
    booleanOptional

    When true, respond with application/x-ndjson events. You can also set Accept: application/x-ndjson.

  • refresh
    booleanOptional

    When true, skip a cached destination and run a fresh unlock.

cURL — JSON
curl -sS https://bypasslab-engine.edge-workspace.workers.dev/bypass \
  -H "X-License-Key: YOUR_LICENSE_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Request-Id: $(uuidgen)" \
  -d '{"url":"https://linkvertise.com/882105/locked-download"}'
cURL — NDJSON Stream
curl -sS -N https://bypasslab-engine.edge-workspace.workers.dev/bypass \
  -H "X-License-Key: YOUR_LICENSE_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/x-ndjson" \
  -d '{"url":"https://linkvertise.com/882105/locked-download","stream":true}'
Success Response
{
  "ok": true,
  "destination": "https://example.com/destination",
  "destinationKind": "url",
  "hops": 2,
  "provider": "Linkvertise",
  "elapsedMs": 1400,
  "cached": false,
  "next": null,
  "creditsCharged": 2,
  "creditsRemaining": 4610
}

Stream Event Types

  • start

    Unlock began. Includes provider and url.

  • hop

    One hop finished. Includes hop index, from, to, and elapsedMs.

  • waiting

    Keepalive while the unlock is still running (for: unlock).

  • done

    Success. Same fields as the JSON success body, plus type: done.

  • password

    Host needs a password. Includes provider. Collect input and retry.

  • error

    Unlock failed. Includes error. Billing failures may include balance and cost.

Gates

Password Flow

Some hosts pause until the end user enters a password. Your app collects that input and sends it on a second POST /bypass. Image captchas are solved on the server for licensed API calls—you do not submit captcha tokens.

  1. 01

    Call POST /bypass with {"url":"<link>" } (no password yet).

  2. 02

    JSON mode returns HTTP 401 with {"ok": false, "needsPassword": true, "provider": "…" }. Stream mode emits {"type": "password", "provider": "…" } then closes.

  3. 03

    Ask the end user for the link password in your UI.

  4. 04

    Call POST /bypass again with the same url and {"password": "<what they typed>" }.

  5. 05

    Wrong password fails the unlock (no credit charge). Collect a new password and retry.

Retry with Password
curl -sS https://bypasslab-engine.edge-workspace.workers.dev/bypass \
  -H "X-License-Key: YOUR_LICENSE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://linkvertise.com/882105/locked-download","password":"user-password"}'
Wallet

GET /license

Read remaining credits, channel totals, and recent ledger entries for the authenticated key.

GET/licenseLicense required
cURL — Balance
curl -sS https://bypasslab-engine.edge-workspace.workers.dev/license \
  -H "X-License-Key: YOUR_LICENSE_KEY"
Success Response
{
  "ok": true,
  "license": {
    "keyPrefix": "BYPASSLAB",
    "status": "active",
    "balance": 4610,
    "createdAt": "2026-01-01T00:00:00.000Z"
  },
  "totals": {
    "toppedUp": 5000,
    "used": 390,
    "byChannel": {
      "website": 100,
      "extension": 200,
      "api": 50,
      "telegram": 40
    }
  },
  "entries": []
}
Catalog

GET /pricing

Public list of live providers with cost, hosts, and whether the host is extension-only. No license header required.

GET/pricing
No license required
cURL — Providers
curl -sS https://bypasslab-engine.edge-workspace.workers.dev/pricing
Success Response
{
  "ok": true,
  "providers": [
    {
      "providerId": "linkvertise",
      "id": "linkvertise",
      "kind": "bypass",
      "name": "Linkvertise",
      "cost": 2,
      "extensionOnly": false,
      "websiteFree": true,
      "hosts": [
        "linkvertise.com"
      ]
    }
  ]
}
Credits
$55,000 tokens

Buy on Telegram or Discord. 5,000 tokens for $5. Credits charge only after a successful unlock.

Reference

HTTP Status Codes

Error responses use {"ok": false, "error": "…" }. Password pauses also return 401 with needsPassword: true.

  • 400

    Bad URL or no API handler for that host.

  • 401

    Missing or invalid license key, or password required.

  • 402

    Not enough credits (balance and cost may be included).

  • 403

    License revoked or unavailable on GET /license.

  • 502

    Upstream unlock failed. Retry or report the URL.

Usage Rules

  • Credits debit only after a successful unlock, not on failed expands.
  • Send X-Request-Id when retrying the same unlock to keep billing idempotent.
  • Do not send X-Client-Channel. License key auth is tracked as the API channel.
  • Never publish your license key in client-side apps or public repos.
  • Chrome-extension-only hosts unlock in the extension—not over this API or Telegram.
Common Questions

HTTP API FAQs

License headers, wallets, supported hosts, and how API unlock differs from free website unlock.

Manage License

Your Bypass Lab license key. Send it as X-License-Key, or as Authorization: Bearer with the same value. That key opens the HTTP API and selects your credit wallet.

Start Unlocking Over HTTP

Add your license, buy tokens when you need credits, then POST /bypass with a supported URL. Use GET /license to confirm balance.