Skip to main content

Documentation Index

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

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

Follow these steps to set up your Optexity account, grab your API key, and install the toolchain locally.

​
1. Create an Account

Head to dashboard.optexity.com and sign up for a free account.

​
2. Get Your API Key

Once logged in, navigate to the API Keys section in your dashboard and create a new key.

​
3. Install the Recorder Extension

Install the Optexity Recorder extension from the Chrome Web Store. This extension captures your browser interactions and converts them into automation workflows.

​
Prerequisites

  • Python 3.11+
  • Git

​
Create and Activate a Python Environment (Optional)

Choose one of the options below.

​
Option A – Conda (includes Python 3.11 and Node.js)

conda create -n optexity python=3.11
conda activate optexity
Install miniconda here: https://docs.conda.io/projects/conda/en/stable/user-guide/install/index.html#installing-in-silent-mode

​
Option B – Python venv

python3 -m venv .venv
source .venv/bin/activate

​
Installation

​
Quick Installation (from PyPI)

Install Optexity directly from PyPI: 
pip install optexity
optexity install-browsers
OR

​
Installation from Source

If you want to clone and edit from source: 
git clone git@github.com:Optexity/optexity.git
cd optexity
pip install -e .
optexity install-browsers

​
Set required environment variables:

OPTEXITY_API_KEY=YOUR_OPTEXITY_API_KEY           # API key used for authenticated requests
GOOGLE_API_KEY=YOUR_GOOGLE_API_KEY      # API key used for Google Gemini
DEPLOYMENT=dev                          # or "prod" in production
You can get your free Google Gemini API key from the Google AI Studio Console.