Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.funbypass.com/llms.txt

Use this file to discover all available pages before exploring further.

​
API Keys

FunBypass uses API keys for authentication. Your key is passed in the request body as the clientKey field — there are no headers or bearer tokens required.

​
Key Types

PrefixTypeDescription
FUN-Balance-basedPay-per-task at $0.75/1,000 tasks. Balance is deducted per task.
PKG-Package-basedSubscription packages with daily/hourly quotas or unlimited tasks.

​
Getting Your API Key

  1. Sign up at app.funbypass.com
  2. Navigate to Dashboard → Settings
  3. Copy your API key
Keep your API key secret. Do not expose it in client-side code or public repositories.

​
Authentication Flow

Every API request requires your clientKey in the request body: 
{
  "clientKey": "FUN-your-api-key-here",
  "task": { ... }
}
The server validates your key and checks:
  1. Key existence — The key must be registered
  2. Account status — Account must not be suspended
  3. Package validity — For PKG- keys, the package must be active and not expired
  4. Balance/Quota — Sufficient balance or remaining quota for the request

​
Balance-Based Keys (FUN-)

  • Cost: 0.75per1,000tasks(0.75 per 1,000 tasks (0.00075 per task)
  • Balance is deducted when a task starts processing
  • If the task fails, the balance is automatically refunded
  • Check your balance via the POST /getBalance endpoint

​
Package-Based Keys (PKG-)

Packages come in several types:
TypeDescription
unlimitedNo task limit during the subscription period
dailyFixed number of tasks per day, resets daily
hourlyFixed number of tasks per hour, resets hourly
Package status can be active, paused, or expired. Only active packages can create tasks.

​
Error Responses

If authentication fails, you’ll receive one of these errors:
Error CodeDescription
ERROR_KEY_DOES_NOT_EXISTAPI key not found
ERROR_ACCOUNT_SUSPENDEDAccount has been suspended
ERROR_PACKAGE_PAUSEDPackage is currently paused
ERROR_PACKAGE_EXPIREDPackage subscription has expired
ERROR_ZERO_BALANCEInsufficient balance (balance-based keys)
ERROR_RATE_LIMIT_EXCEEDEDDaily or hourly quota exceeded (package keys)

​
Next Steps

Create a Task

Start with the createTask endpoint.

Check Balance

Query your current balance programmatically.