PrompteryxBeta
    ⌘K
    PlatformSupport
    Menu
    IntroductionInstall Desktop & extensionQuick StartPlatform Overview
    OverviewWhat you can makeAI Browser Agent in the chatModels and AutoConnectorsSchedulesProjectsExplore and publishingShare linksMemory and SkillsPersonal agent (beta)Welcome, settings and skinsPlans, credits and top-upsPrompteryx DesktopGroups (pilot)Phone app (early access)
    OverviewCreating WorkflowsTesting & DebuggingScheduling
    OverviewGetting StartedCommandsRecordingSettingsStructured OutputParallel AgentsTips & Best Practices
    OverviewInstallationSidebar AgentUsing Attached FilesExecute on Current TabExporting to Visual Studio
    Overview
    OverviewOpen PageClickClick CoordinatesFillExtract TextScreenshotWaitPress KeyFocus ElementBlur ElementSelect TextHighlight ElementSet ViewportGet Bounding BoxScrollHoverSelect OptionAssertionsCookiesEvaluate JavaScriptExample Workflows
    OverviewPrompteryx Browser AgentOpenAI
    OverviewSchedule TriggerWebhook Trigger
    OverviewGoogle SheetsGoogle CalendarConnect Hub (3,000+ apps)Example Workflows
    AI Vision SettingsChrome Automation ProfilesCloud BrowserBrowser Profiles & Persistent ContextVideo RecordingExecution LogsSharing & CollaborationEdit History
    Selectors GuideVariables
    Start hereGet an API keyRun the AI browser agentDrive a cloud browserRun workflows from anywhereUse connected apps (Connect Hub)SDK (TypeScript)CLIMCP for AI assistants
    REST APIWebhooksMCP toolsCloud Browser APICloud Browser quickstartMigrate from Browserbasen8nZapierMake.com

    Need help? Contact Support

    1. Documentation
    2. Developers

    Developers

    One API key, four ways in, three things people come to do. Every example on these pages runs against production.

    Start in two minutes

    Create a key in Cloud Platform → APIs & Webhooks → API Keys (it starts with px_live_ and is shown once), then pick whichever of these feels most natural.

    Terminal
    npx prompteryx login
    npx prompteryx agent "Find the cheapest direct flight from London to Lisbon next Tuesday"
    Code
    import { Prompteryx } from '@prompteryx/sdk'
    const px = new Prompteryx({ apiKey: process.env.PROMPTERYX_API_KEY })
    const result = await px.autopilot.run({ goal: 'Find the cheapest direct flight from London to Lisbon next Tuesday' })
    AI assistant
    claude mcp add --transport http prompteryx https://www.prompteryx.ai/api/mcp
    # then: "Use Prompteryx to find the cheapest direct flight from London to Lisbon next Tuesday"

    Set up with your AI agent

    Using Claude Code, Cursor or ChatGPT? The APIs & Webhooks console (Cloud Platform → APIs & Webhooks) has a copy-paste prompt that points your agent at /llms.txt, our guide for AI assistants (what Prompteryx is, the key pages, then the REST API guide for coding agents), and walks you through a first cost-capped run. For everything in one file, every page and every docs page summarised, use /llms-full.txt.

    The Set up with your AI agent card in the APIs & Webhooks console, with a copy-paste prompt that points a coding agent at /llms.txt
    The 'Set up with your AI agent' card: copy the prompt, paste it to your coding agent, and it handles the rest.
    /llms.txt rendered in the browser: the machine-readable API guide covering auth, limits, response envelope and the agent execute endpoint
    /llms.txt in the browser. Its API guide is generated from the live route code, so it never drifts from the deployed API.

    What do you want to do?

    Run the AI browser agent

    Describe a goal in plain English. Prompteryx opens a browser, does the task, and can save the path as a reusable workflow.

    Drive a cloud browser

    Start a real Chrome in the cloud, connect Playwright to it, and ask Copilot for single steps in English.

    Run workflows from anywhere

    Anything built in Visual Studio has an id. Run it with variables, wait for the result, schedule it, or trigger it from a webhook.

    Use connected apps

    Send email, add rows, post messages through 3,000 Connect Hub apps with the user's own connected accounts.

    How do you want to connect?

    All four doors lead to the same account, plan and allowances.

    REST API

    Plain HTTPS from any language or tool. The foundation everything else uses.

    SDK

    npm install @prompteryx/sdk. TypeScript types and one-line calls.

    CLI

    npx prompteryx. Sign in once in the browser, then run agents, workflows and browsers from a terminal or CI.

    MCP for AI assistants

    Claude, ChatGPT, Cursor and VS Code use Prompteryx as tools. Sign in with OAuth, no key pasted.

    Keys, limits and what they cost
    The same rules apply on every door.

    Platform key (px_live_…) for everything except the cloud browser. Sent as Authorization: Bearer or X-API-Key. 60 requests a minute, 10,000 a day.

    Cloud browser key (pcb_live_…) for browser sessions, created on the same API Keys tab. Billed by the minute.

    OAuth for AI assistants and the CLI: the user signs in on a Prompteryx page and approves. Tokens map to the same account and limits as a key.

    The APIs & Webhooks console's API Keys tab, showing the platform API keys and cloud-browser keys sections with create buttons
    The API Keys tab in Cloud Platform → APIs & Webhooks: platform (Bearer) keys and cloud-browser keys are separate families.

    Access follows your balance, not your plan. If the account has cloud browser minutes or AI credits, any door can spend them. When something is exhausted the API says exactly what to top up.