Skip to content
Last updated

Local API reference

The Browser RPA Local API is served by MoreLogin desktop client V2.73.0 or later 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. Send JSON bodies with Content-Type: application/json. A success response is {data,meta} and an error response is {error,meta}. Authentication failures use the standard Local API 401 format. Handle failures by HTTP status, error.code, details, and issue paths, not by message text. API conventions describes the full rules.

Endpoint directory

Capabilities and nodes

OperationMethod and relative path
Get capabilitiesGET /capabilities
List node typesGET /node-types
Get a node contractGET /node-types/{nodeType}

Workflow validation

OperationMethod and relative path
Validate a workflowPOST /validations

Templates and node editing

OperationMethod and relative path
List templatesGET /templates
Create a templatePOST /templates
Get a templateGET /templates/{templateId}
Replace a templatePUT /templates/{templateId}
Delete a templateDELETE /templates/{templateId}
Copy a templatePOST /templates/{templateId}/copies
List template nodesGET /templates/{templateId}/nodes
Edit template nodesPOST /templates/{templateId}/node-edits

Runs and results

OperationMethod and relative path
Start a runPOST /runs
List runsGET /runs
Get run detailsGET /runs/{runId}
Cancel a runPOST /runs/{runId}/cancel
List node executionsGET /runs/{runId}/nodes
List run artifactsGET /runs/{runId}/artifacts

Request recovery

OperationMethod and relative path
Get a request receiptGET /requests/{key}

Shared reference

Required headers for write requests

OperationIdempotency-KeyX-RPA-Catalog-RevisionIf-Match
Create a templateRecommendedRequired—
Replace a templateRecommendedRequiredRequired
Delete a templateRecommendedNot requiredRequired
Copy a templateRecommendedRequiredRequired: the ETag of the source template
Edit template nodesRecommendedRequiredRequired
Start a runRecommendedRequired—
Cancel a runRecommendedNot required—

Idempotency-Key is optional, but without it a retry after a timeout can repeat the write. Generate a new UUID for each new write intent, and keep it together with the method, path, body, and If-Match until you know the outcome. If-Match takes the exact ETag returned by Get a template. X-RPA-Catalog-Revision takes data.catalogRevision from Get capabilities. Validate a workflow is read-only, needs none of these headers, and leaves no request receipt.

Local machine-readable contract

Read /openapi.json at the local base URL for the HTTP contract. The workflow schema URL is in data.docs.schema from GET /capabilities.

Edit an existing template

Read the latest template and the contracts of the nodes you will edit. For local changes, apply the proposed node edits to the complete tree and validate with purpose:"save", source.kind:"inline", and source.base:{templateId,version}. Submit the operations with node-edits after the candidate passes. A batch either saves one new version or changes nothing. Send complete nodes and blocks when you replace them, and repair references when you remove nodes. Use PUT to replace the whole template. Record child template dependencies as their current {processId,revisionId}, and read the dependencies again after a version conflict.

Recovery

SituationNext step
Write timeout, connection loss, or uncertain outcomeQuery GET /requests/{originalKey}. For completed, use the original result; a completed run registration still needs a run-status check. Poll accepted or committed within a bounded time. For unknown, an ordinary 404, or an expired receipt, stop automatic writes and check the resource.
RPA_REQUEST_NOT_COMMITTED with safeToRetrySameKey=trueRetry the same intent with the original key, method, path, body, and If-Match, if any.
412 version conflictCheck the receipt first. After you confirm that the write did not commit, read the template again, merge, validate, and submit with a new key and the current ETag.
Catalog changedCheck the receipt and confirm that the write did not commit, then refresh capabilities and contracts. If the body and If-Match stay the same, refresh the catalog header and keep the original key.
valid=false or a deterministic input errorFix the reported path and validate again. If the write was recorded as failed, confirm that nothing was committed before you use a new key. On 429 or 503, follow Retry-After and the receipt rules.

To run a saved template, see Run a template with the API.