Anchor Browser

Delete Application -- Deletes an existing application. via DELETE /v1/applications/{applicationId}

Delete Authentication Flow -- Deletes an existing authentication flow. via DELETE /v1/applications/{applicationId}/auth-flows/{authFlowId}

Delete Batch Sessions -- Deletes all sessions in a batch. Running sessions will be terminated and all session data will be removed. via DELETE /v1/batch-sessions/{batch_id}

Delete Certificate -- Delete a CA certificate by name. The certificate will be removed from storage and can no longer be used in new sessions. via DELETE /v1/certificates/{name}

Delete Extension -- Delete an extension and remove it from storage via DELETE /v1/extensions/{id}

Delete Identity -- Deletes an existing identity. via DELETE /v1/identities/{identityId}

Delete Integration -- Deletes an existing integration and removes its stored credentials. via DELETE /v1/integrations/{integrationId}

Delete Profile -- Deletes an existing profile by its name. via DELETE /v1/profiles/{name}

End All Sessions -- Terminates all active browser sessions associated with the provided API key. via DELETE /v1/sessions/all

End Browser Session -- Deletes the browser session associated with the provided browser session ID. Requires a valid API key for authentication. via DELETE /v1/sessions/{session_id}

Delete Session Recording -- Deletes a specific recording from a browser session. Use "primary" as the recording_id to delete the primary recording. via DELETE /v1/sessions/{session_id}/recordings/{recording_id}

Delete Session Tags -- Clears all tags from a browser session. via DELETE /v1/sessions/{session_id}/tags

Delete Task (Legacy) -- Soft deletes a task and all its versions. The task will no longer be accessible but the data is preserved for potential recovery. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via DELETE /v1/task/{taskId}

Delete Task Version (Legacy) -- Soft deletes a specific version of a task. The version will no longer be accessible but the data is preserved for potential recovery. If you are using the new Task Builder, see the Tasks V2 endpoints in this API reference. via DELETE /v1/task/{taskId}/{taskVersion}

Delete Webhook -- Soft-delete a webhook. New events stop fanning out immediately. The events history (`/v1/webhooks/{id}/events`) is still queryable for the retention window even after delete. via DELETE /v1/webhooks/{id}

Agent Access guide -- Unauthenticated onboarding guide. This GET does **not** issue an API key. Follow the `next` field: GET `/v1/agent-access/challenge`, solve, then POST `/v1/agent-access` with `{ token, answer }`. Optional `identity_token` (OIDC JWT) grants more credits. Docs: https://docs.anchorbrowser.io/quickstart/agent-access via GET /v1/agent-access

Agent Access challenge data -- Supporting data for an active Agent Access challenge. Path comes from the challenge response. via GET /v1/agent-access/appendix/{appendixRef}

Get Agent Access challenge -- Get a puzzle and token. Follow next and challenge.prompt, then POST /v1/agent-access with token and answer. via GET /v1/agent-access/challenge

List Applications -- Retrieves all applications for the authenticated team. via GET /v1/applications

Get Application -- Retrieves details of a specific application by its ID. via GET /v1/applications/{applicationId}

List Application Authentication Flows -- Retrieves all authentication flows for a specific application. via GET /v1/applications/{applicationId}/auth-flows

List Application Identities -- Retrieves all identities associated with a specific application. via GET /v1/applications/{applicationId}/identities

List Batch Sessions -- Lists all batch session requests for the authenticated team, with optional filtering by status and pagination support. via GET /v1/batch-sessions

Get Batch Session Status -- Retrieves detailed status information for a specific batch, including progress, individual session details, and any errors that occurred. via GET /v1/batch-sessions/{batch_id}

Get Billing Info -- Retrieves credit balance, current-period credit usage, tier, and billing limits for the authenticated project. via GET /v1/billing

List Certificates -- Get all CA certificates uploaded for the team via GET /v1/certificates

List Extensions -- Get all extensions for the authenticated user via GET /v1/extensions

Get Extension Details -- Get details of a specific extension by its ID via GET /v1/extensions/{id}

Get Identity -- Retrieves details of a specific identity by its ID. via GET /v1/identities/{identityId}

Get Dynamic Auth Flow State -- Read-only snapshot of an in-progress dynamic auth flow. Does not acquire the flow lock or mutate state. Poll this endpoint when: - start/resolve returned `type: detection_failed` with `retryable: true` (the next login step is still being determined and may take longer than the request timeout) - start/resolve timed out or returned 409 while a transition is in flight - you need the current presentation without submitting an answer `view` is that presentation — the same object start/resolve return. Treat it as the live step when `phase` is `settled`. While `phase` is `navigating`, `view` may already describe the next step; `target` is only a progress label for the in-flight transition. Keep polling until `view.type` is `decision`, `form`, `authenticated`, a non-retryable `detection_failed`, or a non-retryable `failed`. Then call `/resolve` only for `decision`/`form`, `/finalize` for `authenticated`, or open `live_view_url` for `detection_failed`. via GET /v1/identities/dynamic/state/{session_id}

List Integrations -- Retrieves all integrations for the authenticated team. via GET /v1/integrations

List Profiles -- Fetches all stored profiles. via GET /v1/profiles

Get Profile -- Retrieves details of a specific profile by its name. via GET /v1/profiles/{name}

List Sessions History Page -- Retrieves a paginated list of sessions for the authenticated team with support for sorting and advanced filtering. This endpoint mirrors the backend session history-page filtering behavior. via GET /v1/sessions

List All Sessions Status -- Retrieves status information for all browser sessions associated with the API key. via GET /v1/sessions/all/status

Async Session Status -- Polling endpoint paired with `POST /v1/sessions/async`. Returns the current lifecycle `status` of the async request and, once the pod is up, the embedded `session` object containing `session_id`, `cdp_url` and `live_view_url`. via GET /v1/sessions/async/{request_id}/status

Get Browser Session -- Retrieves detailed information about a specific browser session. via GET /v1/sessions/{session_id}

Get Requested Human Interventions -- Retrieves pending human-in-the-loop (HITL) requests for a specific active browser session. Requires `human_intervention: true` on the task that is running in the session. The agent pauses until a response is submitted via `POST /v1/sessions/{session_id}/agent/respond-to-human-intervention`. via GET /v1/sessions/{session_id}/agent/requested-human-intervention

List Session Downloads -- Retrieves metadata of files downloaded during a browser session. Requires a valid API key for authentication. via GET /v1/sessions/{session_id}/downloads

Get Browser Session Pages -- Retrieves a list of pages associated with a specific browser session. via GET /v1/sessions/{session_id}/pages

List Session Recordings -- Retrieves the URLs of the browser session's video recordings. Requires a valid API key for authentication. via GET /v1/sessions/{session_id}/recordings

Get Session Tags -- Retrieves the tags associated with a specific browser session. via GET /v1/sessions/{session_id}/tags

List Agent Resources -- List all resources that have been uploaded to the browser session for agent use. Returns resource metadata including name, size, type, and last modified timestamp. via GET /v1/sessions/{sessionId}/agent/files

Get Clipboard Content -- Retrieves the current content of the clipboard via GET /v1/sessions/{sessionId}/clipboard

Get Sessions History -- Retrieves session usage analytics for the authenticated team. via GET /v1/sessions/history

List Pending Human Interventions -- Returns all pending human-in-the-loop (HITL) requests across the team's active browser sessions. Each item includes the intervention request plus the session ID and tags for routing responses. via GET /v1/sessions/pending-interventions

List Tasks (Legacy) -- Retrieves a paginated list of all tasks for the authenticated team. Tasks are returned with their latest version information and metadata. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via GET /v1/task

Get Task Metadata (Legacy) -- Retrieves task metadata without the code content. Useful for getting task information without downloading the full task code. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via GET /v1/task/{taskId}

Get Task Version (Legacy) -- Retrieves a specific version of a task, including the full code content. If you are using the new Task Builder, see the Tasks V2 endpoints in this API reference. via GET /v1/task/{taskId}/{taskVersion}

Get Task Draft (Legacy) -- Retrieves the draft version of a task, including the full code content. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via GET /v1/task/{taskId}/draft

List Task Executions (Legacy) -- Retrieves execution history for a task, including success/failure status, execution times, and outputs. Results can be filtered by version and status. If you are using the new Task Builder, see the Tasks V2 endpoints in this API reference. via GET /v1/task/{taskId}/executions

Get Task Execution Result (Legacy) -- Retrieves a single execution result by its ID. This endpoint is useful for polling execution status in async mode or retrieving detailed execution information. If you are using the new Task Builder, see the Tasks V2 endpoints in this API reference. via GET /v1/task/{taskId}/executions/{executionId}

Get Latest Task Version (Legacy) -- Retrieves the latest version of a task, including the full code content. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via GET /v1/task/{taskId}/latest

List Task Versions (Legacy) -- Retrieves all versions of a specific task, including draft and published versions. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via GET /v1/task/{taskId}/versions

Get Perform Web Task Status -- Get the status of an asynchronous perform-web-task execution by workflow ID. via GET /v1/tools/perform-web-task/{workflowId}/status

List Webhooks -- List every active webhook for the authenticated project. The signing secret is never included. via GET /v1/webhooks

Get Webhook -- Fetch a single webhook config. The signing secret is never returned. via GET /v1/webhooks/{id}

List Webhook Deliveries -- Paginated history of every delivery attempt for this webhook (succeeded, failed, or dead-lettered). Filter by status, event type, or time range. Retention: 7 days. via GET /v1/webhooks/{id}/events

Get Task Generation Status -- Returns the generation status of a task created via `POST /v2/tasks/generate`. via GET /v2/tasks/{taskId}/generation-status

Get Task Run Status -- Retrieves the current status and result of a task run in the non-deprecated Tasks endpoints. via GET /v2/tasks/runs/{runId}/status

Update Authentication Flow -- Updates an existing authentication flow. via PATCH /v1/applications/{applicationId}/auth-flows/{authFlowId}

Update Batch Session -- Updates a batch session. Supports cancelling a running or pending batch, which terminates all running sessions in the batch. via PATCH /v1/batch-sessions/{batch_id}

Update Webhook -- Partial update — pass only the fields you want to change. Setting `enabled: false` immediately stops events from fanning out to this webhook (existing in-flight deliveries finish their attempts). via PATCH /v1/webhooks/{id}

Create Agent Access project -- Issue an Agent Access API key. Submit the challenge `token` and computed integer `answer` from GET /v1/agent-access/challenge. GET on this path returns a guide, not a key. Optional `identity_token` as an OIDC JWT grants more credits. `identity_provider` is optional when the JWT `iss` is Google (`https://accounts.google.com`), GitHub Actions (`https://token.actions.githubusercontent.com`), or Vercel (`https://vercel.com`). Returns `api_key` for header `anchor-api-key`. Docs: https://docs.anchorbrowser.io/quickstart/agent-access via POST /v1/agent-access

Create Application -- Creates a new application for identity management. via POST /v1/applications

Create Authentication Flow -- Creates a new authentication flow for an application. via POST /v1/applications/{applicationId}/auth-flows

Create Identity Token -- Creates an identity token for a specific application. This token is used to initiate an authentication flow for linking user identities to the application. The callback URL must use HTTPS and is where the user will be redirected after authentication. via POST /v1/applications/{applicationId}/tokens

Create Batch Sessions -- Creates multiple browser sessions in a single batch operation. This endpoint allows you to create up to 5,000 browser sessions simultaneously with the same configuration. The batch will be processed asynchronously, and you can monitor progress using the batch status endpoint. via POST /v1/batch-sessions

Retry Failed Batch Sessions -- Retries failed sessions in a batch by creating new browser pods for each failed session. The batch status will be set back to 'processing'. via POST /v1/batch-sessions/{batch_id}/retry

Signal Event -- Signals an event with associated data, unblocking any clients waiting for this event. This enables coordination between different browser sessions, workflows, or external processes. via POST /v1/events/{event_name}

Wait for Event -- Waits for a specific event to be signaled by another process, workflow, or session. This endpoint blocks until the event is signaled or the timeout is reached. Useful for coordinating between multiple browser sessions or workflows. via POST /v1/events/{event_name}/wait

Create Identity -- Creates a new identity for the given source. Credentials are optional. via POST /v1/identities

Reauthenticate Identity -- Re-authenticates an identity on demand: validates the saved browser profile and runs login if it is no longer signed in, then persists the refreshed profile and tears the temporary session down. Equivalent to a session with `identity_skip_validation: false` that ends after auth. via POST /v1/identities/{identityId}/reauthenticate

Finalize Dynamic Auth Flow -- Persists the identity, browser profile, and captured credentials after the flow reaches `authenticated`. The response reports whether the saved login can be replayed unattended (`automatable`). via POST /v1/identities/dynamic/finalize/{session_id}

Resolve Dynamic Auth Flow Step -- Advances the flow by answering the current step. The body depends on the last presentation's `type` — do not mix the two shapes: - **`decision`**: send only `choice` (a `step_id` from `options`). Do not send `option_index` or `values`. - **`form`**: send `option_index` (index into `options`) and `values` (field name → string). Do not send `choice`. Do not call `/resolve` for `detection_failed`, `authenticated`, or `failed`. For retryable `detection_failed`, a timeout, or a 409 (another transition still in flight), poll `GET .../state/{session_id}` until a `decision`/`form`/`authenticated` view appears, then continue. If `detection_failed` is not retryable, open `live_view_url` to finish signing in. via POST /v1/identities/dynamic/resolve/{session_id}

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. via POST /v1/identities/dynamic/start/{session_id}

Create Integration -- Creates a new integration with a third-party service like 1Password. The integration can then be used in browser sessions to automatically load secrets and credentials. via POST /v1/integrations

Create Profile -- Creates a new profile from a browser session. A Profile stores cookies, local storage, and cache. via POST /v1/profiles

Start Browser Session -- Allocates a new browser session for the user, with optional configurations for ad-blocking, captcha solving, proxy usage, and idle timeout. via POST /v1/sessions

Start Browser Session (async) -- Non-blocking variant of `POST /v1/sessions`. Returns a `request_id` immediately and provisions the underlying browser pod in the background. Poll `GET /v1/sessions/async/{request_id}/status` until `status` becomes `ready` to obtain the resolved `session_id`, `cdp_url` and `live_view_url`. via POST /v1/sessions/async

Pause Agent -- Pauses the AI agent for the specified browser session. via POST /v1/sessions/{session_id}/agent/pause

Respond to Human Intervention -- Sends a response to a pending human-in-the-loop (HITL) request for the specified session. Resolving a request unblocks the agent and emits an `intervention.resolved` webhook event when `requestId` is provided. via POST /v1/sessions/{session_id}/agent/respond-to-human-intervention

Resume Agent -- Resumes the AI agent for the specified browser session. via POST /v1/sessions/{session_id}/agent/resume

Pause Session Recording -- Pauses the video recording for the specified browser session. via POST /v1/sessions/{session_id}/recordings/pause

Resume Session Recording -- Resumes the video recording for the specified browser session. via POST /v1/sessions/{session_id}/recordings/resume

Set Clipboard Content -- Sets the content of the clipboard via POST /v1/sessions/{sessionId}/clipboard

Copy Selected Text -- Copies the currently selected text to the clipboard via POST /v1/sessions/{sessionId}/copy

Drag and Drop -- Performs a drag and drop operation from start coordinates to end coordinates via POST /v1/sessions/{sessionId}/drag-and-drop

Navigate to URL -- Navigates the browser session to the specified URL via POST /v1/sessions/{sessionId}/goto

Keyboard Shortcut -- Performs a keyboard shortcut using the specified keys via POST /v1/sessions/{sessionId}/keyboard/shortcut

Type Text -- Types the specified text with optional delay between keystrokes via POST /v1/sessions/{sessionId}/keyboard/type

Mouse Click -- Performs a mouse click at the specified coordinates via POST /v1/sessions/{sessionId}/mouse/click

Mouse Double Click -- Performs a double click at the specified coordinates via POST /v1/sessions/{sessionId}/mouse/doubleClick

Mouse Down -- Performs a mouse button down action at the specified coordinates via POST /v1/sessions/{sessionId}/mouse/down

Mouse Move -- Moves the mouse cursor to the specified coordinates via POST /v1/sessions/{sessionId}/mouse/move

Mouse Up -- Performs a mouse button up action at the specified coordinates via POST /v1/sessions/{sessionId}/mouse/up

Paste Text -- Pastes text at the current cursor position via POST /v1/sessions/{sessionId}/paste

Scroll -- Performs a scroll action at the specified coordinates via POST /v1/sessions/{sessionId}/scroll

Create Task (Legacy) -- Creates a new task or updates an existing task with the same name. Tasks are reusable code snippets that can be executed in browser sessions. Tasks support versioning with draft and published versions. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task

Publish Task Version (Legacy) -- Publishes a specific version of a task. This creates a new version if it doesn't exist, or updates an existing version's metadata. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task/{taskId}/{taskVersion}

Deploy Task (Legacy) -- Deploys a task by creating a new version with auto-incremented version number. This is the recommended way to publish task changes. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task/{taskId}/deploy

Create or Update Task Draft (Legacy) -- Creates or updates the draft version of a task. Draft versions are used for development and testing before publishing. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task/{taskId}/draft

Run Task (Legacy) -- Executes a task in a browser session. The task can be run with a specific version or the latest version. Optionally, you can provide an existing session ID or let the system create a new one. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task/run

Run Task by Name (Legacy) -- Executes a task by its name, always using the latest version. This is a convenience endpoint for running tasks without needing to know the task ID. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via POST /v1/task/run/{taskName}

Execute Code Snippet -- Run a TypeScript snippet in the sandbox against the browser session (query `sessionId` required). via POST /v1/tools/execute-code

Web Unlocker -- Fetch fully-rendered page content from any URL — including bot-protected sites — without managing a browser session. Requests are routed through stealth browsers with residential proxies, captcha solving, and fingerprint randomization. No session is required. See the [Web Unlocker guide](/advanced/web-unlocker) for more details. via POST /v1/tools/fetch/webpage

Perform Web Task -- Start from a URL and perform the given task. via POST /v1/tools/perform-web-task

Create Webhook -- Register a new HTTPS endpoint to receive events. The response includes a one-time `secret` (HMAC-SHA256 signing key) — store it; Anchor never returns it again. Up to 5 webhooks per project. via POST /v1/webhooks

Rotate Webhook Signing Secret -- Mint a new HMAC-SHA256 signing secret. The previous secret remains valid for 24 hours so you can update your verification code at your own pace, then drop the old secret. The new secret is returned exactly once, in the `secret` field. via POST /v1/webhooks/{id}/rotate-secret. DESTRUCTIVE: this irreversibly rotates the webhook's signing secret. The old secret keeps validating for 24 hours (Anchor's own grace window) and then stops permanently; a second rotation mints a third secret rather than restoring the first, so every consumer must be updated within the window.

Send Test Event -- Fire a synthetic event of the given type through the real signing + retry path. Useful during development for confirming your endpoint can verify the signature and is reachable from Anchor's egress IPs. The synthetic delivery counts toward your delivery log so you can see it in `GET /v1/webhooks/{id}/events`. via POST /v1/webhooks/{id}/test

Run a Task -- Triggers execution of a task by ID using the non-deprecated Tasks endpoints. via POST /v2/tasks/{taskId}/run

Generate a Task -- Starts asynchronous generation of a new task from a natural-language prompt. Poll `GET /v2/tasks/{taskId}/generation-status` until the status is `ready`. via POST /v2/tasks/generate

Update Identity -- Updates an existing identity's name, metadata, or credentials. via PUT /v1/identities/{identityId}

Put Session Tags -- Create or replace tags on a browser session. This overwrites any existing tags with the provided list. See [Session Tags](/advanced/session-tags). via PUT /v1/sessions/{session_id}/tags

Update Task Metadata (Legacy) -- Updates task metadata (name and description). This does not affect the task code or versions. If you are using the new Task Builder, see the non-deprecated Tasks endpoints in this API reference. via PUT /v1/task/{taskId}