{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Browser RPA"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"browser-rpa","__idx":0},"children":["Browser RPA"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section is for developers and AI agents that create and run templates programmatically. To automate Android cloud phones, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/rparobotic-process-automation/01-overview/01-rpa-introduction"},"children":["Cloud Phone RPA"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":1},"children":["Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["MoreLogin desktop client V2.73.0 or later is running and signed in. Templates are stored in the signed-in account and appear under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Templates"]}," in the client."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The Local API is reachable at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["http://127.0.0.1:<port>/api/rpa/browser/v1"]},". Use the Local API port shown in the client settings; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["40000"]}," is the default."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication works the same way as for the rest of the Local API. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/authentication"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Runs need a Chromium browser profile (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserTypeId: 1"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /capabilities"]}," returns the operations, limits, and documentation URLs available to your client and account. Check it before you build a template."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":2},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Concept"},"children":["Concept"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Template"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A saved workflow with a title, a description, and its child template dependencies. Every save creates a new version."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ordered tree of nodes in a template. It starts with one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start"]}," node and ends with one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end"]}," node."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Node"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One step, such as opening a URL or clicking an element. Each node type has a contract that defines its inputs and outputs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The browser profile that a run uses. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["environmentId"]}," is the profile's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["envId"]}," from the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/browser/local-api"},"children":["Browser Local API"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One execution of a saved template version on an environment. A run has node execution records and artifacts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request receipt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The stored outcome of a write request sent with an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Idempotency-Key"]},". Use it to find out what happened after a timeout."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-this-api-differs-from-other-local-api-endpoints","__idx":3},"children":["How this API differs from other Local API endpoints"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Browser RPA endpoints don't use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{code, msg, data}"]}," format described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/getting-started/response-format"},"children":["Common Response Format"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["They return real HTTP status codes, such as 201, 202, 409, 412, 422, 429, and 503."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A success body is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{data, meta}"]}," and an error body is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{error, meta}"]},". Error codes are strings such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RPA_VALIDATION_FAILED"]},"; see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/error-codes"},"children":["Error codes"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Write requests use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Idempotency-Key"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-RPA-Catalog-Revision"]}," headers. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/local-api#required-headers-for-write-requests"},"children":["Required headers for write requests"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication failures use the standard Local API 401 format."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started","__idx":4},"children":["Get started"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/quickstart"},"children":["Quickstart"]},": Discover capabilities and node contracts, then validate and save a template that returns the final page URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/run-api-example"},"children":["Run a template with the API"]},": Preflight the saved version, start a run, and read the result."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/node-contract-guide"},"children":["Shared fields and workflow structure"]},": Learn the workflow layout, references, timeouts, and retries."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/nodes"},"children":["Node catalog"]},": Look up the inputs, defaults, references, and outputs of each node."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/local-api"},"children":["Local API reference"]},": Find every endpoint, the headers that writes need, and how to recover from timeouts and version conflicts."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run a template by hand, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/run"},"children":["Run a template in the desktop client"]},"."]}]},"headings":[{"value":"Browser RPA","id":"browser-rpa","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"How this API differs from other Local API endpoints","id":"how-this-api-differs-from-other-local-api-endpoints","depth":2},{"value":"Get started","id":"get-started","depth":2}],"frontmatter":{"seo":{"title":"Browser RPA"}},"lastModified":"2026-11-20T14:40:39.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/browser-rpa/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}