Skip to content

Test

Classification: NEEDS-DESKTOP

Status: NEEDS-DESKTOP Kameleo is a Windows and Mac desktop antidetect browser application. It cannot be installed via pip or npm. A paid subscription is required. There is no free tier.

Install method: Download the Windows or Mac installer from kameleo.io. Run the installer, sign in with a paid account, and start the Kameleo Engine before running any automation code.

Cost/access: Paid subscription required. No free tier.


Smoke Test -- Verify the Engine Is Reachable

Before running any SDK code, confirm the local Kameleo Engine is up and responding on port 5050.

Command:

bash
curl -s http://localhost:5050/status

Expected success output:

json
{"status":"ok","version":"5.x.y"}

Any 200 OK response with a status field confirms the Engine is running and the API is available.

Smoke Test -- Python SDK Connectivity Check

python
from kameleo.local_api_client import KameleoLocalApiClient

client = KameleoLocalApiClient(endpoint='http://localhost:5050')
client.verify_engine_ready()
print("Engine is ready")

Expected success output:

Engine is ready

verify_engine_ready() raises KameleoException if the Engine is not running or the version is incompatible with the SDK. No exception means the connection is valid.

Smoke Test -- Node.js SDK Version Check

bash
node -e "const k = require('@kameleo/local-api-client'); console.log('SDK loaded:', k.KameleoLocalApiClient ? 'ok' : 'fail')"

Expected success output:

SDK loaded: ok

Fingerprint Search Sanity Check (Python)

python
from kameleo.local_api_client import KameleoLocalApiClient

client = KameleoLocalApiClient(endpoint='http://localhost:5050')
client.verify_engine_ready()

fps = client.fingerprint.search_fingerprints(
    device_type='desktop',
    os_family='windows',
    browser_product='chrome'
)

print(f"Fingerprints returned: {len(fps)}")
print(f"First fingerprint ID: {fps[0].id}")

Expected success output:

Fingerprints returned: 25
First fingerprint ID: <uuid>

A result of 25 (the max per page) and a valid UUID fingerprint ID confirms your plan is active, the SDK is communicating with the Engine, and fingerprint data is being served from the cloud.

What Failure Looks Like

SymptomLikely Cause
ConnectionRefusedError on port 5050Engine not running. Start the Kameleo desktop app or Docker container.
KameleoException: Engine version mismatchSDK version does not match Engine version. Run pip install --upgrade kameleo.local-api-client.
Fingerprints returned: 0Plan limit reached or account not logged in to the Engine.
401 Unauthorized from curlEngine requires a logged-in Kameleo account. Open the app and sign in.

Template / Boilerplate Availability

Kameleo does not ship an official standalone starter template or boilerplate repository. Working examples for Python, JavaScript, and C# are embedded in the Quickstart documentation and in the GitHub organization. Copy the quickstart example for your language as your starting scaffold.