{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Local API reference"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"local-api-reference","__idx":0},"children":["Local API reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Browser RPA Local API is served by MoreLogin desktop client V2.73.0 or later 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":"p","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"]},". Send JSON bodies with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: application/json"]},". A success response is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{data,meta}"]}," and an error response is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{error,meta}"]},". Authentication failures use the standard Local API 401 format. Handle failures by HTTP status, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error.code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]},", and issue paths, not by message text. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/common"},"children":["API conventions"]}," describes the full rules."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoint-directory","__idx":1},"children":["Endpoint directory"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"capabilities-and-nodes","__idx":2},"children":["Capabilities and nodes"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and relative path"},"children":["Method and relative path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-capabilities"},"children":["Get capabilities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /capabilities"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-node-types"},"children":["List node types"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /node-types"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-node-type"},"children":["Get a node contract"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /node-types/{nodeType}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-validation","__idx":3},"children":["Workflow validation"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and relative path"},"children":["Method and relative path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/validate-workflow"},"children":["Validate a workflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /validations"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"templates-and-node-editing","__idx":4},"children":["Templates and node editing"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and relative path"},"children":["Method and relative path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-templates"},"children":["List templates"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /templates"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/create-template"},"children":["Create a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /templates"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-template"},"children":["Get a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /templates/{templateId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/replace-template"},"children":["Replace a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /templates/{templateId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/delete-template"},"children":["Delete a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /templates/{templateId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/copy-template"},"children":["Copy a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /templates/{templateId}/copies"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-template-nodes"},"children":["List template nodes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /templates/{templateId}/nodes"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/edit-template-nodes"},"children":["Edit template nodes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /templates/{templateId}/node-edits"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"runs-and-results","__idx":5},"children":["Runs and results"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and relative path"},"children":["Method and relative path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/start-run"},"children":["Start a run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /runs"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-runs"},"children":["List runs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /runs"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-run"},"children":["Get run details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /runs/{runId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/cancel-run"},"children":["Cancel a run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /runs/{runId}/cancel"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-run-nodes"},"children":["List node executions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /runs/{runId}/nodes"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/list-run-artifacts"},"children":["List run artifacts"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /runs/{runId}/artifacts"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-recovery","__idx":6},"children":["Request recovery"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method and relative path"},"children":["Method and relative path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-request-receipt"},"children":["Get a request receipt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /requests/{key}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"shared-reference","__idx":7},"children":["Shared reference"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/common"},"children":["API conventions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/data-types"},"children":["Data models"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/workflow"},"children":["Workflow, variables and structure nodes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/error-codes"},"children":["Error codes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/recovery"},"children":["Error details and recovery matrix"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/observation"},"children":["Run observation and request recovery"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-headers-for-write-requests","__idx":8},"children":["Required headers for write requests"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Idempotency-Key"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Idempotency-Key"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"X-RPA-Catalog-Revision"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-RPA-Catalog-Revision"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"If-Match"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/create-template"},"children":["Create a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/replace-template"},"children":["Replace a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/delete-template"},"children":["Delete a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/copy-template"},"children":["Copy a template"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required: the ETag of the source template"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/edit-template-nodes"},"children":["Edit template nodes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/start-run"},"children":["Start a run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/cancel-run"},"children":["Cancel a run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]}," until you know the outcome. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]}," takes the exact ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ETag"]}," returned by ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-template"},"children":["Get a template"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-RPA-Catalog-Revision"]}," takes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.catalogRevision"]}," from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/get-capabilities"},"children":["Get capabilities"]},". ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/api/validate-workflow"},"children":["Validate a workflow"]}," is read-only, needs none of these headers, and leaves no request receipt."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"local-machine-readable-contract","__idx":9},"children":["Local machine-readable contract"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/openapi.json"]}," at the local base URL for the HTTP contract. The workflow schema URL is in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.docs.schema"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /capabilities"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"edit-an-existing-template","__idx":10},"children":["Edit an existing template"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["purpose:\"save\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.kind:\"inline\""]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source.base:{templateId,version}"]},". Submit the operations with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{processId,revisionId}"]},", and read the dependencies again after a version conflict."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recovery","__idx":11},"children":["Recovery"]},{"$$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":"Situation"},"children":["Situation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Next step"},"children":["Next step"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write timeout, connection loss, or uncertain outcome"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /requests/{originalKey}"]},". For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completed"]},", use the original result; a completed run registration still needs a run-status check. Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accepted"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["committed"]}," within a bounded time. For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unknown"]},", an ordinary 404, or an expired receipt, stop automatic writes and check the resource."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RPA_REQUEST_NOT_COMMITTED"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["safeToRetrySameKey=true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retry the same intent with the original key, method, path, body, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]},", if any."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["412 version conflict"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check 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."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Catalog changed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the receipt and confirm that the write did not commit, then refresh capabilities and contracts. If the body and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["If-Match"]}," stay the same, refresh the catalog header and keep the original key."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid=false"]}," or a deterministic input error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix 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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Retry-After"]}," and the receipt rules."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run a saved template, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/browser-rpa/run-api-example"},"children":["Run a template with the API"]},"."]}]},"headings":[{"value":"Local API reference","id":"local-api-reference","depth":1},{"value":"Endpoint directory","id":"endpoint-directory","depth":2},{"value":"Capabilities and nodes","id":"capabilities-and-nodes","depth":3},{"value":"Workflow validation","id":"workflow-validation","depth":3},{"value":"Templates and node editing","id":"templates-and-node-editing","depth":3},{"value":"Runs and results","id":"runs-and-results","depth":3},{"value":"Request recovery","id":"request-recovery","depth":3},{"value":"Shared reference","id":"shared-reference","depth":3},{"value":"Required headers for write requests","id":"required-headers-for-write-requests","depth":2},{"value":"Local machine-readable contract","id":"local-machine-readable-contract","depth":2},{"value":"Edit an existing template","id":"edit-an-existing-template","depth":2},{"value":"Recovery","id":"recovery","depth":2}],"frontmatter":{"seo":{"title":"Local API reference"}},"lastModified":"2026-11-20T14:40:39.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/browser-rpa/local-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}