Skip to content

Browser RPA

Browser RPA automates repeatable tasks in a local Chromium browser profile: open pages, interact with elements, read results, and control the flow with conditions and loops. You build the workflow as a template, save it to your MoreLogin account, and run it on a browser profile, either in the desktop client or through the Browser RPA Local API.

This section is for developers and AI agents that create and run templates programmatically. To automate Android cloud phones, see Cloud Phone RPA.

Requirements

  • MoreLogin desktop client V2.73.0 or later is running and signed in. Templates are stored in the signed-in account and appear under Custom Templates in the client.
  • The Local API is reachable at http://127.0.0.1:<port>/api/rpa/browser/v1. Use the Local API port shown in the client settings; 40000 is the default.
  • Authentication works the same way as for the rest of the Local API. See Authentication.
  • Runs need a Chromium browser profile (browserTypeId: 1).
  • GET /capabilities returns the operations, limits, and documentation URLs available to your client and account. Check it before you build a template.

Key concepts

ConceptMeaning
TemplateA saved workflow with a title, a description, and its child template dependencies. Every save creates a new version.
WorkflowThe ordered tree of nodes in a template. It starts with one start node and ends with one end node.
NodeOne step, such as opening a URL or clicking an element. Each node type has a contract that defines its inputs and outputs.
EnvironmentThe browser profile that a run uses. environmentId is the profile's envId from the Browser Local API.
RunOne execution of a saved template version on an environment. A run has node execution records and artifacts.
Request receiptThe stored outcome of a write request sent with an Idempotency-Key. Use it to find out what happened after a timeout.

How this API differs from other Local API endpoints

The Browser RPA endpoints don't use the {code, msg, data} format described in Common Response Format.

  • They return real HTTP status codes, such as 201, 202, 409, 412, 422, 429, and 503.
  • A success body is {data, meta} and an error body is {error, meta}. Error codes are strings such as RPA_VALIDATION_FAILED; see Error codes.
  • Write requests use the Idempotency-Key, If-Match, and X-RPA-Catalog-Revision headers. See Required headers for write requests.
  • Authentication failures use the standard Local API 401 format.

Get started

  1. Quickstart: Discover capabilities and node contracts, then validate and save a template that returns the final page URL.
  2. Run a template with the API: Preflight the saved version, start a run, and read the result.
  3. Shared fields and workflow structure: Learn the workflow layout, references, timeouts, and retries.
  4. Node catalog: Look up the inputs, defaults, references, and outputs of each node.
  5. Local API reference: Find every endpoint, the headers that writes need, and how to recover from timeouts and version conflicts.

To run a template by hand, see Run a template in the desktop client.