# Data models

> Fields match the [HTTP Schema](/browser-rpa/local-api#local-machine-readable-contract). Dynamic node inputs use the [Workflow Schema](/browser-rpa/local-api#local-machine-readable-contract) and the [workflow semantics](/browser-rpa/api/workflow).


In the tables, "Required" means that the field is required when the object that contains it is present. Optional does not mean nullable. Unknown fields are rejected, except in JSON or map objects that explicitly allow arbitrary keys.

## JsonValue

A JSON value can be null, a boolean, a finite number, a string, an array, or an object. A JsonObject must be an object, and its values must be valid JSON, recursively. The values undefined/NaN/Infinity are not accepted.

## JsonObject

A JSON value can be null, a boolean, a finite number, a string, an array, or an object. A JsonObject must be an object, and its values must be valid JSON, recursively. The values undefined/NaN/Infinity are not accepted.

## Workflow

For details, see [Workflow structure and semantics](/browser-rpa/api/workflow) and the [structure schema](/browser-rpa/local-api#local-machine-readable-contract). The schema checks only the structure. It does not replace the semantic, permission, and run checks on the server.

## Metadata

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `requestId` | string | Yes | Trace ID of this HTTP request. This is the response meta, not the display meta of a node. Format "uuid". |
| `catalogRevision` | string | Yes | Content revision of the node contracts. Format: sha256: followed by 64 hexadecimal digits. |
| `replayed` | boolean | No | When true, the result of the original intent is returned. This request still has a different requestId. |


## Issue

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `code` | string | Yes | Stable machine-readable code. Programs make decisions based on it. |
| `message` | string | Yes | Human-readable description. Do not base program logic on this text. |
| `severity` | `error` / `warning` | Yes | An error prevents the check from passing. A warning needs to be explained. |
| `path` | string | Yes | JSON Pointer relative to the root of the current request body. It differs from TemplateNodes.items[].path. |
| `nodeId` | string | No | Stable node ID in the template. Min length 1; max length 128. |
| `field` | string | No | The corresponding node input field or rule field. |
| `expected` | string | No | Expected type or constraint. |
| `suggestion` | string | No | Suggested fix. |


## NotCommittedDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `safeToRetrySameKey` | `true` | Yes | Returned as true only in the original account/team, after recovery has completed and it is confirmed that nothing was committed. |


## VersionConflictDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `templateId` | string | Yes | ID of the template that was checked this time and that you currently have access to. Min length 1; max length 128. |
| `expectedVersion` | integer | Yes | Version specified in the request (for a 412, the version in If-Match). Minimum 1. |
| `currentVersion` | integer | Yes | Current version seen at check time. It is not a lock that you can use directly for the next write. GET the template again. Minimum 1. |


## WorkflowErrorDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `workflowPath` | string | No | Location of the first issue in the final complete TemplateWrite. It is not a path in the current node-edits request body. |


## NodePageLimitDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `limit` | `"nodePageBytes"` | Yes | See the model definition. |
| `maxBytes` | integer | Yes | See the model definition. Minimum 1. |


## CatalogChangedDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `expectedCatalogRevision` | string | Yes | See the model definition. |
| `currentCatalogRevision` | string | Yes | See the model definition. |


## ReceiptExpiredDetails

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `resourceId` | string or null | Yes | Original resource ID recorded in the tombstone. It is null when the ID could not be kept. |
| `originalStatus` | integer or null | Yes | Known original HTTP status. It is null when there is no definite value. |


## Error

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `code` | string | Yes | Stable machine-readable code. Programs make decisions based on it. |
| `message` | string | Yes | Human-readable description. Do not base program logic on this text. |
| `retryable` | boolean | Yes | Whether you can recover with the original intent. It does not mean that you can switch to a different key and run the website actions again. |
| `issues` | array<[Issue](/browser-rpa/api/data-types#issue)> | Yes | List of structured issues. It is [] when there are no issues. |
| `details` | [JsonObject](/browser-rpa/api/data-types#jsonobject) or null | Yes | Additional error information, or null. It contains no private data. |


For known codes, details is constrained by allOf conditions and cannot fall back to an arbitrary object: RPA_REQUEST_NOT_COMMITTED → NotCommittedDetails (required); RPA_TEMPLATE_VERSION_CONFLICT → VersionConflictDetails (required); RPA_VERSION_CONFLICT → VersionConflictDetails or null; RPA_VALIDATION_FAILED → WorkflowErrorDetails or null; RPA_CATALOG_CHANGED → CatalogChangedDetails or null; RPA_REQUEST_EXPIRED → ReceiptExpiredDetails (required). For complete examples and the recovery matrix, see [Error details and recovery matrix](/browser-rpa/api/recovery).

## ErrorResponse

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `error` | [Error](/browser-rpa/api/data-types#error) | Yes | Required structured error object. It cannot be null. |
| `meta` | [Metadata](/browser-rpa/api/data-types#metadata) | Yes | See the model definition. |


## DependencyPin

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `processId` | string | Yes | ID of the referenced local child template. Min length 1; max length 128. |
| `revisionId` | string | Yes | Immutable revision ID. Min length 1; max length 128. |


## TemplateWrite

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `title` | string | Yes | Display name. On template writes, 1–100 characters after trimming. Min length 1; max length 100. |
| `description` | string | Yes | Description text. Required on template writes. Use an empty string to clear it. Max length 1000. |
| `workflow` | [Workflow](/browser-rpa/api/data-types#workflow) | Yes | Native editor workflow object. It runs in the order of nodes/blocks. |
| `dependencies` | array<[DependencyPin](/browser-rpa/api/data-types#dependencypin)> | Yes | List of child template dependencies. It must match the child templates that applySubProcess references in the workflow, one to one. revisionId is the child template's current revisionId (`remote:<childTemplateId>@<version>`). If there are no dependencies, submit []. At run time, as in the client, each run takes a frozen snapshot of the latest child templates at that time. Max items 1000. |


## TemplateSummary

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `title` | string | Yes | Display name. On template writes, 1–100 characters after trimming. |
| `description` | string | Yes | Description text. Required on template writes. Use an empty string to clear it. |
| `version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |
| `revisionId` | string | Yes | Immutable revision ID. Min length 1; max length 128. |
| `createdAt` | integer | Yes | Creation time, Unix milliseconds. Minimum 0. |
| `updatedAt` | integer | Yes | Last update time, Unix milliseconds. Minimum 0. |


## Template

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `title` | string | Yes | Display name. On template writes, 1–100 characters after trimming. |
| `description` | string | Yes | Description text. Required on template writes. Use an empty string to clear it. |
| `workflow` | [Workflow structure](/browser-rpa/api/workflow) / [JSON Schema](/browser-rpa/local-api#local-machine-readable-contract) | Yes | Native editor workflow object. It runs in the order of nodes/blocks. |
| `dependencies` | array<[DependencyPin](/browser-rpa/api/data-types#dependencypin)> | Yes | List of child template dependencies. It must match the child templates that applySubProcess references in the workflow, one to one. revisionId is the child template's current revisionId (`remote:<childTemplateId>@<version>`). If there are no dependencies, submit []. At run time, as in the client, each run takes a frozen snapshot of the latest child templates at that time. Max items 1000. |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |
| `revisionId` | string | Yes | Immutable revision ID. Min length 1; max length 128. |
| `createdAt` | integer | Yes | Creation time, Unix milliseconds. Minimum 0. |
| `updatedAt` | integer | Yes | Last update time, Unix milliseconds. Minimum 0. |
| `warnings` | array<[Issue](/browser-rpa/api/data-types#issue)> | Yes | Issues and limitations that don't block saving. Assess the impact of each one. |
| `redactedPaths` | array<string> | Yes | Compatibility field. It is always an empty array in the current version. The Local API doesn't redact template content. |


## NodeEdit

**Option 1**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"insert"` | Yes | Discriminator field. It must match this option. |
| `parentId` | string or null | Yes | ID of the target parent container; null means the root. |
| `beforeNodeId` | string or null | Yes | The node is inserted or moved before this sibling node. A null value appends it to the end of the container. |
| `node` | [Workflow structure](/browser-rpa/api/workflow) / [JSON Schema](/browser-rpa/local-api#local-machine-readable-contract) | Yes | Complete node object, including any blocks that need to be kept. |


**Option 2**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"replace"` | Yes | Discriminator field. It must match this option. |
| `nodeId` | string | Yes | Stable node ID in the template. Min length 1; max length 128. |
| `node` | [Workflow structure](/browser-rpa/api/workflow) / [JSON Schema](/browser-rpa/local-api#local-machine-readable-contract) | Yes | Complete node object, including any blocks that need to be kept. |


**Option 3**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"move"` | Yes | Discriminator field. It must match this option. |
| `nodeId` | string | Yes | Stable node ID in the template. Min length 1; max length 128. |
| `parentId` | string or null | Yes | ID of the target parent container; null means the root. |
| `beforeNodeId` | string or null | Yes | The node is inserted or moved before this sibling node. A null value appends it to the end of the container. |


**Option 4**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"remove"` | Yes | Discriminator field. It must match this option. |
| `nodeId` | string | Yes | Stable node ID in the template. Min length 1; max length 128. |


## NodeEdits

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `operations` | array<[NodeEdit](/browser-rpa/api/data-types#nodeedit)> | Yes | Atomic node edit operations, applied in order. The whole batch creates only one template version. Min items 1; max items 100. |
| `variables` | [Workflow structure](/browser-rpa/api/workflow) / [JSON Schema](/browser-rpa/local-api#local-machine-readable-contract) | No | Complete variable declaration. If it is omitted in a node edit, the existing variables are kept. |
| `dependencies` | array<[DependencyPin](/browser-rpa/api/data-types#dependencypin)> | No | List of child template dependencies. It must match the child templates that applySubProcess references in the workflow, one to one. revisionId is the child template's current revisionId (`remote:<childTemplateId>@<version>`). If there are no dependencies, submit []. At run time, as in the client, each run takes a frozen snapshot of the latest child templates at that time. |


## TemplateNodes

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items` | array<object> | Yes | Array of items on the current page or in the current resource. |
| `templateVersion` | integer | Yes | Template version at the time this node tree was queried. Minimum 1. |


**`items[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items[].id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `items[].parentId` | string or null | Yes | ID of the target parent container; null means the root. |
| `items[].path` | string | Yes | JSON Pointer relative to the workflow root, such as /nodes/1. It is not the issue.path of a request body. |
| `items[].node` | [Workflow structure](/browser-rpa/api/workflow) / [JSON Schema](/browser-rpa/local-api#local-machine-readable-contract) | Yes | Complete node object, including any blocks that need to be kept. |


## ParameterValues

Map from any declared parameter name to `{kind:"json",value:JsonValue}`. Use `{}` when there are no parameters. Parameters take the same shape as in client runs:

| Parameter type | value | Description |
|  --- | --- | --- |
| Regular string/number/boolean/array/object | The corresponding JSON value | The type, range, and length are checked against the [initial variables](/browser-rpa/api/workflow#2-initial-variables-six-field-types) declaration. |
| Private string (extra.private=true) | Plain-text string | The server stores the value in local secure storage and then runs the workflow. Run records keep only a reference for this parameter (node outputs and run outputs derived from it are not redacted). If you omit it, the template default value is used. `"******"` also means that the template default value is used. |
| File (extra.type=file) | Absolute local path string (single file) or array of strings (multiple files) | The server references the file at that path directly and does not copy it. The path must exist, must be a readable regular file, and must meet the extension, count, and size limits. Otherwise, the result is RPA_INVALID_PARAMETERS at the location `/parameters/<name>`. The file is checked again before each execution. If the file no longer exists or is unusable at that time, that run fails, and error.details.issues identifies the parameter. |
| String that allows local paths (extra.localPath=true) | Local path string | Same as a regular string. |


A `purpose=run` preflight performs only the same checks and does not write to secure storage.

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `kind` | `"json"` | Yes | Discriminator field: inline/template for source, or json for run parameters. |
| `value` | [JsonValue](/browser-rpa/api/data-types#jsonvalue) | Yes | The actual JSON value. Its type must satisfy the corresponding variable or condition. |


## ValidationSource

**Option 1**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `kind` | `"inline"` | Yes | Discriminator field: inline/template for source, or json for run parameters. |
| `template` | [TemplateWrite](/browser-rpa/api/data-types#templatewrite) | Yes | Complete body of the candidate template, or a summary of the template frozen for the run. Read it according to the model that contains it. |
| `base` | object | No | For inline validation, the version of the existing template and its eligibility for keeping private default values. It is not saved. |


**`base` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `base.templateId` | string | Yes | Target template ID (the cloud ID of the template in Custom Templates in the client, a numeric string). Min length 1; max length 128. |
| `base.version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |


**Option 2**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `kind` | `"template"` | Yes | Discriminator field: inline/template for source, or json for run parameters. |
| `templateId` | string | Yes | Target template ID (the cloud ID of the template in Custom Templates in the client, a numeric string). Min length 1; max length 128. |
| `version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |


## ValidationRequest

**Option 1**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `purpose` | `"save"` | Yes | With save, only the conditions for saving are checked. With run, parameters, the environment, and run limits are also checked. |
| `source` | [ValidationSource](/browser-rpa/api/data-types#validationsource) | Yes | Selects a candidate template or a saved template. Use exactly one option. |


**Option 2**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `purpose` | `"run"` | Yes | With save, only the conditions for saving are checked. With run, parameters, the environment, and run limits are also checked. |
| `source` | [ValidationSource](/browser-rpa/api/data-types#validationsource) | Yes | Selects a candidate template or a saved template. Use exactly one option. |
| `environmentId` | string | Yes | ID of an actual environment. Get it from an environment query. Min length 1; max length 128. |
| `parameters` | [ParameterValues](/browser-rpa/api/data-types#parametervalues) | Yes | Map from parameter names to {kind:json,value:JSON} (plain text for private parameters, absolute local paths for file parameters; see ParameterValues). Use {} when there are no parameters. |


## ValidationReport

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `valid` | boolean | Yes | It is true when there are no static errors. It does not mean that an actual run succeeds. |
| `issues` | array<[Issue](/browser-rpa/api/data-types#issue)> | Yes | List of structured issues. It is [] when there are no issues. |
| `truncated` | boolean | Yes | It is true when the issue limit was reached. Validate again after you fix the issues. |
| `runtimeChecks` | array<object> | Yes | Items that still need confirmation at run time. An empty array does not prove that the real web page is usable, and it does not explain why there are no items. |
| `effectiveInputs` | object | Yes | Optional diagnostic summary keyed by nodeId. defaultsApplied contains only the safe defaults filled in by this validation, and unresolvedFields lists the input fields that were not resolved. Entries can be omitted, or {} can be returned, so a missing entry does not tell you whether normalization took place. |
| `workflowHash` | string | Yes | Content identifier for diagnostics. It is not guaranteed to stay stable across inline/saved sources, catalogs, or normalization steps, and it does not prove that the workflow was saved. See the supplementary rules in common.md. |
| `catalogRevision` | string | Yes | Content revision of the node contracts. Format: sha256: followed by 64 hexadecimal digits. |
| `dependencyRevisions` | array<[DependencyPin](/browser-rpa/api/data-types#dependencypin)> | Yes | Exact dependency revisions used for freezing or validation. |


**`runtimeChecks[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `runtimeChecks[].nodeId` | string | Yes | Stable node ID in the template. Min length 1; max length 128. |
| `runtimeChecks[].field` | string | Yes | The corresponding node input field or rule field. |
| `runtimeChecks[].code` | string | Yes | The current general value is RPA_RUNTIME_CHECK_REQUIRED. An unknown code added in the future still means that confirmation at run time is pending. See common.md. |
| `runtimeChecks[].reason` | string | Yes | Reason for unavailability, isolation, or the runtime check. |


## Capabilities

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `apiVersion` | `"v1"` | Yes | Major version of the HTTP API. |
| `schemaVersion` | string | Yes | Version of the authoring contract (semver). |
| `catalogRevision` | string | Yes | Content revision of the node contracts. Format: sha256: followed by 64 hexadecimal digits. |
| `editorVersions` | array<integer> | Yes | List of editor versions that are currently accepted. |
| `parameterVersions` | array<`1`> | Yes | List of parameter versions that can currently be written through the public API. |
| `operations` | array<string> | Yes | Array of operationIds that are registered on this instance and authorized for the current client. |
| `runtimeProfile` | `"v1"` | Yes | External execution policy: the same as runs in the client, with no extra restrictions on nodes, fields, or parameters. |
| `limits` | object | Yes | Live limits. Use the values in the response. |
| `docs` | object | Yes | Relative URLs of the documentation that matches the current capabilities. |


**`limits` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `limits.requestBytes` | integer | Yes | Maximum size of an HTTP body, in bytes. Minimum 1. |
| `limits.workflowBytes` | integer | Yes | Maximum size of the compactly serialized workflow, in bytes. Minimum 1. |
| `limits.maxNodes` | integer | Yes | Maximum number of nodes per template, including containers. Minimum 1. |
| `limits.maxDepth` | integer | Yes | Maximum nesting depth. Minimum 1. |
| `limits.maxEdits` | integer | Yes | Maximum number of operations in one node edit. Minimum 1. |
| `limits.maxIssues` | integer | Yes | Maximum number of issues returned at once. Minimum 1. |
| `limits.requestsPerMinute` | integer | Yes | Maximum number of requests per minute for the currently logged-in client. Minimum 1. |
| `limits.maxInFlightWrites` | integer | Yes | Maximum number of in-flight writes for the currently logged-in client. Minimum 1. |
| `limits.nodeDataBytes` | integer | Yes | Maximum size of a single data value in a node execution record, in bytes of compact UTF-8 JSON. Default 65536. A value over the limit is omitted as a whole. Minimum 1. |
| `limits.nodePageBytes` | integer | Yes | Maximum size of one complete page of node execution records, in bytes of compact UTF-8 JSON. Default 8388608. A page over the limit returns 413. This is not the request body limit. Minimum 1. |


**`docs` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `docs.openapi` | string | Yes | URL of the machine-readable document for the local HTTP API. |
| `docs.schema` | string | Yes | URL of the workflow.schema.json document that matches the catalog revision. |
| `docs.aiGuide` | string | Yes | URL of the AI operating guide. |
| `docs.nodeIndex` | string | Yes | URL of the node catalog. |
| `docs.examples` | string | Yes | URL of the complete example document. |


## NodeTypeSummary

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `action` | string or null | Yes | Executor action name. It is null for structure nodes. |
| `nodeVersion` | integer | Yes | Contract version of this node type. It is not a lock on a single node in a template. Minimum 1. |
| `category` | string | Yes | Node category. Filter by the actual catalog values. |
| `title` | string | Yes | Display name of the node type. |
| `description` | string | Yes | Description of the node type's behavior. |
| `authorable` | boolean | Yes | Whether this type can be used in public authoring. Its fields are still subject to fieldPolicies. |
| `runtimeSupported` | boolean | Yes | Whether the internal executor supports it. |
| `externalRunnable` | boolean | Yes | Whether the current instance can run this node through the Local API. It is true once the action is registered. A run validation is still required. |
| `documentationComplete` | boolean | Yes | Whether the complete executable rules have been published. |
| `unavailableReasons` | array<string> | Yes | List of reasons the node is unavailable. An empty array means there is no known reason. |


## ConditionRule

**Option 1**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `eq` | Yes | Discriminator field. It must match this option. |
| `field` | string | Yes | The corresponding node input field or rule field. |
| `value` | [JsonValue](/browser-rpa/api/data-types#jsonvalue) | Yes | The actual JSON value. Its type must satisfy the corresponding variable or condition. |


**Option 2**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `in` | Yes | Discriminator field. It must match this option. |
| `field` | string | Yes | The corresponding node input field or rule field. |
| `values` | array<[JsonValue](/browser-rpa/api/data-types#jsonvalue)> | Yes | Set of values allowed by the in condition. |


**Option 3**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `and` / `or` | Yes | Discriminator field. It must match this option. |
| `rules` | array<[ConditionRule](/browser-rpa/api/data-types#conditionrule)> | Yes | Set of child conditions for and/or, with at least one item. Min items 1. |


**Option 4**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"not"` | Yes | Discriminator field. It must match this option. |
| `rule` | [ConditionRule](/browser-rpa/api/data-types#conditionrule) | Yes | Child condition of not. |


**Option 5**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `op` | `"always"` | Yes | Discriminator field. It must match this option. |


## NodeContract

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `action` | string or null | Yes | Executor action name. It is null for structure nodes. |
| `nodeVersion` | integer | Yes | Contract version of this node type. It is not a lock on a single node in a template. Minimum 1. |
| `category` | string | Yes | Node category. Filter by the actual catalog values. |
| `title` | string | Yes | Display name of the node type. |
| `description` | string | Yes | Description of the node's behavior and semantic rules. |
| `authorable` | boolean | Yes | Whether this type can be used in public authoring. Its fields are still subject to fieldPolicies. |
| `runtimeSupported` | boolean | Yes | Whether the internal executor supports it. |
| `externalRunnable` | boolean | Yes | Whether the current instance can run this node through the Local API. It is true once the action is registered. A run validation is still required. |
| `documentationComplete` | boolean | Yes | Whether the complete executable rules have been published. |
| `unavailableReasons` | array<string> | Yes | List of reasons the node is unavailable. An empty array means there is no known reason. |
| `inputSchema` | [JsonObject](/browser-rpa/api/data-types#jsonobject) | Yes | JSON Schema of the action inputs. For structure types, it validates the complete node. |
| `outputVariants` | array<object> | Yes | Output schema branches, selected by mode. |
| `referenceRules` | array<object> | Yes | Allowed value forms and reference scope for each field. |
| `conditionalRules` | array<object> | Yes | Conditional rules checked after defaults and bindings take effect. |
| `fieldPolicies` | array<object> | Yes | Per-field sensitivity and authoring restrictions. They also apply to bindings. |
| `defaults` | [JsonObject](/browser-rpa/api/data-types#jsonobject) | Yes | Normalized safe execution defaults, merged into omitted fields. x-editor-default is not used during execution. |
| `examples` | array<object> | Yes | Array of samples with inputs and illustrative outputs for this node. |
| `sideEffects` | array<`browser` / `read` / `write` / `file` / `script` / `credential` / `environment`> | Yes | Categories of side effects that running the node can cause. |
| `docUrl` | string | Yes | URL of the detailed documentation for this node. |


**`outputVariants[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `outputVariants[].when` | [ConditionRule](/browser-rpa/api/data-types#conditionrule) | Yes | Declarative condition. Only the operations in ConditionRule are supported. |
| `outputVariants[].schema` | [JsonObject](/browser-rpa/api/data-types#jsonobject) | Yes | JSON Schema of node.data under this condition. It is not a documentation URL. |
| `outputVariants[].publicProjection` | string | Yes | Describes how data in run records differs from the executor output (no redaction; only handles cannot be serialized). |


**`referenceRules[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `referenceRules[].field` | string | Yes | The corresponding node input field or rule field. |
| `referenceRules[].allow` | array<`literal` / `reference` / `template` / `numericExpression`> | Yes | Which of the literal/reference/template/numericExpression forms are allowed. |
| `referenceRules[].expectedType` | string | Yes | Target type after the reference is resolved. |
| `referenceRules[].scope` | string | Yes | Scope in which references are visible. |


**`conditionalRules[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `conditionalRules[].when` | [ConditionRule](/browser-rpa/api/data-types#conditionrule) | Yes | Declarative condition. Only the operations in ConditionRule are supported. |
| `conditionalRules[].requiredFields` | array<string> | Yes | Fields that are required under this condition. |
| `conditionalRules[].forbiddenFields` | array<string> | Yes | Fields that are forbidden under this condition. |
| `conditionalRules[].constraints` | array<string> | Yes | Constraint descriptions. Before publication, each one must map to an executable validation rule. |
| `conditionalRules[].issueCode` | string | Yes | Issue code returned when the condition is violated. |


**`fieldPolicies[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `fieldPolicies[].field` | string | Yes | The corresponding node input field or rule field. |
| `fieldPolicies[].sensitivity` | `public` / `secret` / `credential` / `localPath` / `inlineFile` / `sourceCode` | Yes | Data sensitivity category of the field. |
| `fieldPolicies[].authoringPolicy` | `allowed` / `privateReferenceOnly` / `restricted` | Yes | Always `allowed` in the current version: the field accepts a literal or a reference. The other two values are kept only for compatibility with earlier versions. |
| `fieldPolicies[].when` | [ConditionRule](/browser-rpa/api/data-types#conditionrule) | Yes | Declarative condition. Only the operations in ConditionRule are supported. |


**`examples[]` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `examples[].id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `examples[].input` | [JsonObject](/browser-rpa/api/data-types#jsonobject) | Yes | Sample input. |
| `examples[].expectedOutput` | [JsonValue](/browser-rpa/api/data-types#jsonvalue) | Yes | Illustrative output value. The actual value comes from a run. |
| `examples[].requirements` | array<string> | Yes | Prerequisites for the sample. |


## StartRun

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `templateId` | string | Yes | Target template ID (the cloud ID of the template in Custom Templates in the client, a numeric string). Min length 1; max length 128. |
| `version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |
| `environmentId` | string | Yes | ID of an actual environment. Get it from an environment query. Min length 1; max length 128. |
| `parameters` | [ParameterValues](/browser-rpa/api/data-types#parametervalues) | Yes | Map from parameter names to {kind:json,value:JSON} (plain text for private parameters, absolute local paths for file parameters; see ParameterValues). Use {} when there are no parameters. |


## RunStatus

Type: `queued` / `preparing` / `running` / `cancel_requested` / `success` / `failed` / `cancelled` / `stopped` / `missed`. A run whose stop cannot be confirmed, and a run that is recovered after the client exits, also return `failed`. For the reason, see `error.code` (`OUTCOME_UNKNOWN` / `RPA_INTERRUPTED`). Check isolation as well.

## RunSummary

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `status` | [RunStatus](/browser-rpa/api/data-types#runstatus) | Yes | Current status. Evaluate it against the enum values of the model. |
| `template` | object | Yes | Complete body of the candidate template, or a summary of the template frozen for the run. Read it according to the model that contains it. |
| `environment` | object | Yes | Summary of the target environment frozen for the run. |
| `createdAt` | integer | Yes | Creation time, Unix milliseconds. Minimum 0. |
| `startedAt` | integer or null | Yes | Start time. It is null if the run has not started yet (always present in node records). |
| `endedAt` | integer or null | Yes | End time. It is null if the run has not ended yet. |
| `startAfter` | integer or null | Yes | Earliest start time when the template task is set to start with a delay, Unix milliseconds. Before that time, the run stays queued and does not occupy the environment. It is null when there is no delay or for a debug run. |
| `hasNodeErrors` | boolean | Yes | Whether any node error occurred. Do not look only at the overall status and ignore this field. |
| `isolation` | object or null | Yes | Environment isolation state, or null. When it is quarantined, the environment cannot be reused. |


**`template` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `template.id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `template.title` | string | Yes | Display name. On template writes, 1–100 characters after trimming. |
| `template.version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |
| `template.revisionId` | string | Yes | Immutable revision ID. Min length 1; max length 128. |


**`environment` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `environment.id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `environment.name` | string | Yes | Public name. |


**`isolation` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `isolation.state` | `quarantined` / `released` | Yes | Environment isolation state: quarantined or released. |
| `isolation.reason` | string | Yes | Reason for unavailability, isolation, or the runtime check. |
| `isolation.since` | integer | Yes | Time the isolation started, Unix milliseconds. Minimum 0. |
| `isolation.releasedAt` | integer or null | Yes | Release time. It is null if the environment has not been released yet. |


## PublicError

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `code` | string | Yes | Stable machine-readable code. Programs make decisions based on it. |
| `message` | string | Yes | Human-readable description. Do not base program logic on this text. |
| `details` | object | No | Allowlisted context for node or run errors (field, reason, httpStatus, netError, systemCode, phase, and so on). For the meaning of each field, see [node and run error codes](/browser-rpa/api/error-codes). It is omitted when there is no context. |


## RunDetail

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `run` | [RunSummary](/browser-rpa/api/data-types#runsummary) | Yes | Summary of the current run. |
| `result` | object or null | Yes | Run result. It is null until a result is produced. The outputs field is the map of workflow outputs. |
| `snapshot` | object | Yes | Summary of the frozen template and dependency revisions, without the original content. |


**`result` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `result.outputs` | [JsonObject](/browser-rpa/api/data-types#jsonobject) | Yes | Workflow outputs. The actual values are returned as is (not redacted). |
| `result.error` | [PublicError](/browser-rpa/api/data-types#publicerror) or null | Yes | Public error object, or null. |


**`snapshot` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `snapshot.templateId` | string | Yes | Target template ID (the cloud ID of the template in Custom Templates in the client, a numeric string). Min length 1; max length 128. |
| `snapshot.version` | integer | Yes | Current editable template version. Read it from an actual response. Minimum 1. |
| `snapshot.revisionId` | string | Yes | Immutable revision ID. Min length 1; max length 128. |
| `snapshot.dependencyRevisions` | array<[DependencyPin](/browser-rpa/api/data-types#dependencypin)> | Yes | Exact dependency revisions used for freezing or validation. |


## ArtifactMetadata

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Unique ID of the resource or node. Take it from a previous response; don't guess it. Min length 1; max length 128. |
| `runId` | string | Yes | ID of the run that the artifact belongs to. Min length 1; max length 128. |
| `name` | string | Yes | Public name. |
| `path` | string | Yes | Absolute local path that the node actually wrote to. The file is not copied or archived. If the file is later moved or deleted, the path is still kept. Min length 1; max length 4096. |
| `mimeType` | string | Yes | Media type of the artifact. |
| `size` | integer | Yes | Size of the artifact, in bytes. Minimum 0. |
| `createdAt` | integer | Yes | Creation time, Unix milliseconds. Minimum 0. |
| `contentAvailable` | `false` | Yes | Currently always false. The API does not provide file content. Read the file locally by path. |


## NodeExecution

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `id` | string | Yes | Stable record ID of one logical node invocation. Retries update attempts on the same record. Different invocations in a loop or child workflow get different IDs. Min length 1; max length 128. |
| `nodeId` | string | Yes | Stable node ID in the template. Min length 1; max length 128. |
| `workflowRevisionId` | string | Yes | Revision ID of the root workflow or child workflow that this node belongs to. Min length 1; max length 128. |
| `invocationPath` | string | Yes | Opaque invocation path provided by the server. Copy it only to filter by exact match. Do not guess or build its structure. Min length 1; max length 4096. |
| `status` | `running` / `success` / `failed` / `cancelled` | Yes | Current status of this invocation. An invocation whose end cannot be confirmed is failed, with error.code OUTCOME_UNKNOWN or RPA_INTERRUPTED. This does not prove that side effects on the website have stopped. |
| `attempts` | integer | Yes | Number of attempts started within the same logical node invocation. It is not a list of separate history records. Minimum 0. |
| `startedAt` | integer | Yes | Start time. It is null if it has not started yet (always present in node records). Minimum 0. |
| `endedAt` | integer or null | Yes | End time. It is null if it has not ended yet. |
| `durationMs` | integer or null | Yes | Time the node took, in milliseconds. It can be null if the node has not finished yet. |
| `data` | [JsonObject](/browser-rpa/api/data-types#jsonobject) or null | Yes | Business data or public node output. Read it according to the model of its context. |
| `dataTruncated` | boolean | Yes | When data exceeds the public byte limit, the whole value is omitted as null and this field is set to true. This does not change the execution status. It is false when no data was produced. |
| `error` | [PublicError](/browser-rpa/api/data-types#publicerror) or null | Yes | Public error object, or null. |
| `artifacts` | array<[ArtifactMetadata](/browser-rpa/api/data-types#artifactmetadata)> | Yes | Metadata of the artifacts associated with this node. |
| `matchedIndex` | integer | No | Optional match index, starting at 1. Minimum 1. |


## RequestReceipt

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `key` | string | Yes | Idempotency-Key UUID of the original write intent. Format "uuid". |
| `operation` | string | Yes | operationId of the original business operation. |
| `state` | `accepted` / `committed` / `completed` / `failed` / `unknown` | Yes | Registration/commit/publication state of the original write intent. It is not the execution status of a run. |
| `createdAt` | integer | Yes | Creation time, Unix milliseconds. Minimum 0. |
| `updatedAt` | integer | Yes | Last update time, Unix milliseconds. Minimum 0. |
| `replayAvailable` | boolean | Yes | Whether the receipt is still within the full replay window. |
| `resourceId` | string or null | Yes | ID of the resource that the original operation created or acted on. Can be null. |
| `originalStatus` | integer or null | Yes | Original HTTP status code. Can be null. |
| `result` | [JsonValue](/browser-rpa/api/data-types#jsonvalue) | Yes | The data of the original successful response, without headers/ETag. It is null when no result was produced or the state is failed. |
| `safeError` | [PublicError](/browser-rpa/api/data-types#publicerror) | No | Public code/message of a failed receipt, with no internal stack trace. |


## NodeTypeSummaryPage

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items` | array<[NodeTypeSummary](/browser-rpa/api/data-types#nodetypesummary)> | Yes | Array of items on the current page or in the current resource. |
| `total` | integer | Yes | Total number of matches. Minimum 0. |
| `page` | integer | Yes | Page number, starting at 1. Minimum 1. |
| `pageSize` | integer | Yes | Items per page. Default 20, maximum 100. Minimum 1; maximum 100. |


## TemplateSummaryPage

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items` | array<[TemplateSummary](/browser-rpa/api/data-types#templatesummary)> | Yes | Array of items on the current page or in the current resource. |
| `total` | integer | Yes | Total number of matches. Minimum 0. |
| `page` | integer | Yes | Page number, starting at 1. Minimum 1. |
| `pageSize` | integer | Yes | Items per page. Default 20, maximum 100. Minimum 1; maximum 100. |


## RunSummaryPage

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items` | array<[RunSummary](/browser-rpa/api/data-types#runsummary)> | Yes | Array of items on the current page or in the current resource. |
| `total` | integer | Yes | Total number of matches. Minimum 0. |
| `page` | integer | Yes | Page number, starting at 1. Minimum 1. |
| `pageSize` | integer | Yes | Items per page. Default 20, maximum 100. Minimum 1; maximum 100. |


## NodeExecutionPage

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `items` | array<[NodeExecution](/browser-rpa/api/data-types#nodeexecution)> | Yes | Array of items on the current page or in the current resource. |
| `total` | integer | Yes | Total number of matches. Minimum 0. |
| `page` | integer | Yes | Page number, starting at 1. Minimum 1. |
| `pageSize` | integer | Yes | Items per page. Default 20, maximum 100. Minimum 1; maximum 100. |