Start Dynamic Auth Flow

curl --request POST \
  --url https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/login",
  "host": "example.com"
}
'

import requests

url = "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}"

payload = {
    "url": "https://example.com/login",
    "host": "example.com"
}
headers = {
    "anchor-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'anchor-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://example.com/login', host: 'example.com'})
};

fetch('https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/login',
    'host' => 'example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "anchor-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anchor-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}")
  .header("anchor-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["anchor-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": "decision",
  "session_id": "abc-123",
  "host": "example.com",
  "current_step_label": "Sign in",
  "step_id": "root/login",
  "options": [
    {
      "step_id": "root/login/password",
      "label": "Email and password",
      "automatable": true
    },
    {
      "step_id": "root/login/google",
      "label": "Continue with Google",
      "automatable": false
    },
    {
      "step_id": "root/login/sso",
      "label": "Continue with SSO",
      "automatable": false
    }
  ]
}

Identities

Start Dynamic Auth Flow

Starts (or restarts) a dynamic auth flow in an existing browser session. session_id is required in the path. Advances until the next presentation (decision, form, detection_failed, authenticated, or failed).

If the response is detection_failed with retryable: true, or the request times out, keep polling GET /v1/identities/dynamic/state/{session_id} — some login steps take longer than a single start/resolve call. If detection_failed and retryable is false, open live_view_url to finish signing in. Do not treat a timeout as a hard stop until view.type is failed or detection_failed and retryable is false.

POST

identities

dynamic

start

{session_id}

Start Dynamic Auth Flow

curl --request POST \
  --url https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id} \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com/login",
  "host": "example.com"
}
'

import requests

url = "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}"

payload = {
    "url": "https://example.com/login",
    "host": "example.com"
}
headers = {
    "anchor-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'anchor-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: 'https://example.com/login', host: 'example.com'})
};

fetch('https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/login',
    'host' => 'example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "anchor-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("anchor-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}")
  .header("anchor-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.anchorbrowser.io/v1/identities/dynamic/start/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["anchor-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/login\",\n  \"host\": \"example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "type": "decision",
  "session_id": "abc-123",
  "host": "example.com",
  "current_step_label": "Sign in",
  "step_id": "root/login",
  "options": [
    {
      "step_id": "root/login/password",
      "label": "Email and password",
      "automatable": true
    },
    {
      "step_id": "root/login/google",
      "label": "Continue with Google",
      "automatable": false
    },
    {
      "step_id": "root/login/sso",
      "label": "Continue with SSO",
      "automatable": false
    }
  ]
}

Authorizations

anchor-api-key

string

header

required

API key passed in the header

Path Parameters

session_id

string

required

Active browser session that will drive the login.

Body

application/json

url

string<uri>

required

Landing URL to open in the session (login page).

Example:

"https://example.com/login"

host

string

required

Hostname of url. Must match the URL hostname after normalization.

Example:

"example.com"

Response

First presentation of the auth flow

decision
form
detection_failed
authenticated
failed

Presentation returned by start/resolve. GET /state nests the same object as view when there is something to show. Discriminated on type. Call /resolve only for decision or form.

session_id

string

required

host

string

required

Hostname the flow was started for.

current_step_label

string

required

Human-readable label of the current login step.

step_id

string

required

Identifier of the current login step.

cdp_url

string

required

CDP websocket URL of the session driving the login.

live_view_url

string

required

URL to watch or take over the session in a browser.

type

enum<string>

required

Available options:

decision

options

object[]

required

Each item is { step_id, label, automatable }. POST /resolve with { "choice": "<step_id>" }.

Show child attributes

discovery_error

string

Set when automatic step detection hit an error. A partial flow may still be presented.

⌘I

Agent Access

AI Tools

Browser Sessions

Tasks

Tools

Applications

Identities

Profiles

OS Level Control

Session Recordings

Agentic capabilities

Extensions

Certificates

Integrations

Event Coordination

Batch Sessions

Tasks (Legacy)

Billing

Webhooks

Start Dynamic Auth Flow

Authorizations

Path Parameters

Body

Response