Quickstart

This guide will cover the essential steps to get you started with the Incogniton API, including installing the SDK, launching a browser profile, and making your first API calls.

Requirements

Before you begin, let’s make sure you have everything you need:

• An Incogniton account — sign up here if you don't have one
• The Incogniton desktop app installed and running on your computer
• At least one browser profile created within the Incogniton app
• A working knowledge of either TypeScript/JavaScript or Python

The SDK and REST API communicate locally with the running Incogniton desktop application over CDP or WebDriver. All commands are executed against profiles stored in the app, and no network calls leave your machine unless your automation script explicitly navigates to external pages.

Installation and Usage

In this section, we will walk through the steps to install the Incogniton SDK and make your first API calls. You may also use direct HTTP requests to the REST API if you prefer.

1. 1

   Install the SDK

   We provide official SDKs for TypeScript (Node.js) and Python. Choose your preferred language and run the matching install command below:

   Install SDK

   Node.js SDKPython SDK

   bash

   npm install incogniton
   

   CopyCopied!
2. 2

   Make Your First API Call

   Launch a browser profile via the SDK or a direct HTTP request, as shown below. This initializes an Incogniton browser instance on your local server with the specified profile.

   Launch profile via API

   Node.js SDKPython SDKcURL

   POST

   Profile

   import { IncognitonClient } from 'incogniton';
   
   const client = new IncognitonClient();
   const profileId = 'your-profile-id';
   
   await client.profile.launch(profileId);
   

   CopyCopied!
3. 3

   Make Your First Browser Automation Call

   Use the Incogniton Browser Automation SDK with Playwright to perform a quick automation task: launch a profile, navigate to a page, and take a screenshot.

   Browser automation tasks and endpoints in the IncognitonBrowser module are SDK-exclusive and cannot be called directly via the REST API.

   You can initialize the browser on the client instance from the previous step (Python example below), which helps reduce resource overhead.

   Automate browser

   Node.js SDKPython SDK

   CDP

   Automation

   import { IncognitonBrowser } from 'incogniton';
   
   const profileId = 'your-profile-id';
   
   // Create a browser automation instance
   const browser = new IncognitonBrowser({ headless: true });
   
   // Launch a Playwright browser instance
   const playwrightBrowser = await browser.startPlaywright();
   
   // Open a new page and navigate
   const page = await playwrightBrowser.newPage();
   await page.goto('https://example.com');
   
   // Take a screenshot
   await page.screenshot({ path: 'example.png' });
   
   // Close the browser when done
   await browser.close(playwrightBrowser);
   

   CopyCopied!

You now have a running browser instance and can proceed to advanced automation tasks.

Next Steps

---

Need help? Join our community or contact support.

---