Skip to main content

API Requests

All Client API v2 endpoints require an API key in the X-Api-Key header.
Create or copy API keys in API keys.

Proxy Connections

Proxy tools and proxy traffic use proxy username/password credentials inside the proxy URL.
You do not need to manage proxy usernames through Client API v2. For rotating proxies, call POST /v2/proxy/rotating/connections and copy connection.connectionString from the response.
For static proxies, call GET /v2/proxy/static and copy items[n].connection.connectionString.

Cloud Browser Connections

Cloud Browser control requests use the Client API key. Creating or getting an active session returns a signed connectUrl for Playwright or Puppeteer. Do not add X-Api-Key to the WebSocket connection. The signed URL authorizes only that session and expires with it. Use the URL exactly as returned, keep it out of logs, and get the active session again when you need a fresh URL.

Which Credential Goes Where

Do not place your API key inside a proxy connection string. Do not send proxy passwords in the X-Api-Key header. Treat signed browser connection and live-view URLs as temporary secrets: do not log, publish, or reuse them for another session.

Test API Access

Test Proxy Access

Use the proxy URL returned by the API.
Or check the proxy through the Client API: