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
    3. Developers
    5. Authentication

    Authentication & API Keys

    Create and use API keys to authenticate with all Prompteryx developer interfaces

    Creating an API Key
    1. Go to Cloud Platform → APIs & Webhooks → API Keys
    2. Click Create key, give it a name and choose when it expires. Under What this key can use, untick any area the key doesn't need (workflows, executions, browser, integrations, profile, chat, media, apps, explore). All are ticked by default; a key gets 403 INSUFFICIENT_SCOPE outside its areas (see the REST API scopes)
    3. Copy your key immediately — it will only be shown once
    px_live_*
    Production keys — full access to execute and manage workflows
    The APIs & Webhooks console's API Keys tab, with the platform API keys (Bearer) and cloud-browser keys (x-api-key) sections
    Both key families live in Cloud Platform → APIs & Webhooks → API Keys: platform keys (Bearer) and cloud-browser keys (x-api-key).
    Using Your API Key

    Your API key works across all Prompteryx developer interfaces. Choose the method that matches your use case:

    Recommended for REST API calls

    Authorization: Bearer px_live_YOUR_API_KEY
    Rate Limits

    API Rate Limits

    • • 60 requests per minute
    • • 10,000 requests per day

    Every response carries X-RateLimit-Limit-Minute, X-RateLimit-Remaining-Minute, X-RateLimit-Limit-Day and X-RateLimit-Remaining-Day. Over the limit the API answers 429 RATE_LIMIT_EXCEEDED with a Retry-After header in seconds.

    Subscription Limits Also Apply
    API and MCP usage draws on the same allowances as the app: workflow runs, cloud browser minutes, AI credits and Connect Hub calls. When one runs out the API says which (QUOTA_EXHAUSTED or QUOTA_EXCEEDED, see the error table). Top-ups are used once the plan allowance is spent.
    Usage Tiers

    API, SDK, CLI and MCP usage comes out of your plan's allowances:

    IncludedFree TrialStarterDeveloperProEnterprise
    Price / month$0$20$20$45Custom
    AI credits / month505001001,5001,500
    Cloud browser minutes / month106,00012,00015,0001,200
    Workflow runs / month1,5003,0003,00012,00012,000
    Connect Hub calls / month—100—30020,000
    Residential proxy data—100 MB1,024 MB250 MB500 MB
    Video recording—YesYesYesYes

    Billed monthly. Full comparison on the pricing page.

    Security Best Practices
    • • Never commit API keys to version control. Use environment variables or a secrets manager.
    • • Rotate keys regularly, and at once if you suspect one has leaked: Rotate next to a key on the API Keys tab creates a replacement with the same name, permissions and lifetime, shows it once, and revokes the old key. Search and the status filter help you find a key.
    • • Use separate keys for different environments or applications so you can revoke them independently.
    • • Verify webhook signatures: create a signing secret (whsec_…) on the API Keys page and check X-Prompteryx-Signature-256 on every completion callback. See Webhooks.
    • • Sign in instead of pasting keys where you can: the CLI and MCP clients support OAuth (prompteryx login), with tokens that expire after an hour and refresh automatically.