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.

​
Prerequisites

​
Step 1: Create a Task

Send a POST request to create a new task: 
import requests

response = requests.post("https://api.funbypass.com/createTask", json={
    "clientKey": "FUN-your-api-key",
    "task": {
        "type": "FunCaptchaTask",
        "websiteURL": "https://example.com",
        "websitePublicKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "websiteSubdomain": "client-api",
        "proxy": "http://user:pass@ip:port"
    }
})

data = response.json()
task_id = data["taskId"]
print(f"Task created: {task_id}")
Response: 
{
  "errorId": 0,
  "taskId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "created"
}

​
Step 2: Poll for the Result

Wait a few seconds, then poll for the result: 
import time

while True:
    result = requests.get(f"https://api.funbypass.com/getTaskResult/{task_id}").json()

    if result["status"] == "ready":
        print(f"Result token: {result['solution']['token']}")
        break
    elif result.get("errorId", 0) != 0:
        print(f"Error: {result['errorCode']}")
        break

    time.sleep(0.5)
Response (ready): 
{
  "errorId": 0,
  "solution": {
    "token": "session_result_token..."
  },
  "taskId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "ready"
}

​
Step 3: Use the Result Token

Use the returned token value where the target flow expects the FunCaptcha result token.

​
Next Steps

Authentication

Learn about API key types and authentication.

Task Lifecycle

Understand the full task flow in detail.