ANanchorbrowser
Browser Sessions

Start Browser Session

Changed on

Allocates a new browser session for the user, with optional configurations for ad-blocking, captcha solving, proxy usage, and idle timeout.

post/v1/sessions

Request

  • Base URL
    https://api.anchorbrowser.io
  • Auth
    API key in header anchor-api-key

Request body

identity_skip_validationboolean

When true (default), skip profile validation for active identities and reuse the saved browser profile. Set to false to validate the profile and re-authenticate if it is no longer signed in. Pending identities still authenticate on first use.

identity_async_authboolean

Run identity authentication in the background and return the session immediately.

Example request

{
  "session": {
    "tags": [
      "production",
      "scraping",
      "customer-123"
    ],
    "domain_allowlist": [
      "example.com",
      "example.org"
    ]
  },
  "integrations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "1PASSWORD",
      "configuration": {
        "load_mode": "all"
      }
    }
  ],
  "identities": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Response

Successfully returned a browser object

Changes

  • 9d755f22df0eRevision changes
    • info

      added the new optional request property /

  • b3bfdb98c79eRevision changes
    • warning

      removed the request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property /

    • info

      added the new optional request property /