Skip to content

Usage

Minimal example: launch a profile and navigate with Playwright (Node.js)

This is the canonical minimal usage pattern. The Incogniton desktop app must be running and the profile ID must exist inside it.

typescript
import { IncognitonBrowser } from 'incogniton'

const browser = new IncognitonBrowser({
  profileId: 'your-profile-id',
  headless: true,
})

const pwBrowser = await browser.startPlaywright()
const page = await pwBrowser.newPage()
await page.goto('https://example.com')
await page.screenshot({ path: 'example.png' })
await browser.close(pwBrowser)

Replace 'your-profile-id' with the profile ID shown in the Incogniton app (hover over a profile row to see its ID).

List and launch profiles (Node.js)

javascript
import { IncognitonClient } from 'incogniton'

const client = new IncognitonClient()

// List all profiles
const allProfiles = await client.profile.list()
console.log(allProfiles)

// Launch a specific profile (opens it in the desktop app)
const profileId = 'your-profile-id'
await client.profile.launch(profileId)

// Check profile status
const status = await client.profile.get_status(profileId)
console.log(status)

Python API client

python
from incogniton import IncognitonClient

client = IncognitonClient()

# Get a specific profile
profile = await client.profile.get('your-profile-id')

# List all profiles
all_profiles = await client.profile.list()

# Check status
status = await client.profile.get_status('your-profile-id')

Proxy assignment

Assign a proxy to a profile inside the Incogniton desktop app under the profile's "Privacy and Network" settings tab. Supported formats: HTTP, HTTPS, SOCKS4, SOCKS5. Built-in free proxies are available in 9 countries (US, Hong Kong, Brazil, Netherlands, Australia, UK, Germany, India, Ukraine).

For geo-targeted work, assign a residential proxy in the target city. The proxy geo should match the profile's timezone and language settings so all fingerprint signals are internally consistent.

REST API

The desktop app exposes a local REST API. Endpoints cover profile CRUD, launch/stop, cookie import/export, Puppeteer and Selenium launch, and a health probe. Full reference: https://api-docs.incogniton.com.