@epilot/sdk 2.8.7 → 2.8.9

package/definitions/access-token-runtime.json

@@ -1 +1 @@
-{"s":"https://access-token.sls.epilot.io","o":[["createAccessToken","post","/v1/access-tokens",null,1],["listAccessTokens","get","/v1/access-tokens",[["token_type","q"]]],["revokeAccessToken","delete","/v1/access-tokens/{id}",[["id","p",true]]],["getAccessTokenJwks","get","/v1/access-tokens/.well-known/jwks.json"],["getAccessTokenOIDC","get","/v1/access-tokens/.well-known/openid-configuration"],["getPublicTokenJwks","get","/v1/access-tokens/public/.well-known/jwks.json"],["getPublicTokenOIDC","get","/v1/access-tokens/public/.well-known/openid-configuration"]],"v":"3.0.3"}
+{"s":"https://access-token.sls.epilot.io","o":[["createAccessToken","post","/v1/access-tokens",null,1],["listAccessTokens","get","/v1/access-tokens",[["token_type","q"]]],["revokeAccessToken","delete","/v1/access-tokens/{id}",[["id","p",true]]],["getAccessTokenJwks","get","/v1/access-tokens/.well-known/jwks.json"],["getAccessTokenOIDC","get","/v1/access-tokens/.well-known/openid-configuration"],["getPublicTokenJwks","get","/v1/access-tokens/public/.well-known/jwks.json"],["getPortalPreviewTokenJwks","get","/v1/access-tokens/portal-preview/.well-known/jwks.json"],["getPublicTokenOIDC","get","/v1/access-tokens/public/.well-known/openid-configuration"],["getPortalPreviewTokenOIDC","get","/v1/access-tokens/portal-preview/.well-known/openid-configuration"]],"v":"3.0.3"}

package/definitions/access-token.json

@@ -70,6 +70,14 @@
                     ]
                   }
                 },
+                "portal_preview": {
+                  "value": {
+                    "name": "Portal Preview Token for previewing customer portal",
+                    "token_type": "portal_preview",
+                    "portal_id": "portal_abc123",
+                    "portal_user_id": "user_xyz789"
+                  }
+                },
                 "app": {
                   "value": {
                     "name": "App Access Token",
@@ -361,6 +369,63 @@
         }
       }
     },
+    "/v1/access-tokens/portal-preview/.well-known/jwks.json": {
+      "get": {
+        "operationId": "getPortalPreviewTokenJwks",
+        "summary": "getPortalPreviewTokenJwks",
+        "description": "Get jwks public key set to verify portal preview tokens generated by this API",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "responses": {
+          "200": {
+            "description": "Set of jwks",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "keys": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "alg": {
+                            "type": "string",
+                            "example": "RS256"
+                          },
+                          "e": {
+                            "type": "string",
+                            "example": "AQAB"
+                          },
+                          "kid": {
+                            "type": "string",
+                            "example": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw="
+                          },
+                          "kty": {
+                            "type": "string",
+                            "example": "RSA"
+                          },
+                          "n": {
+                            "type": "string",
+                            "example": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ"
+                          },
+                          "use": {
+                            "type": "string",
+                            "example": "sig"
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/access-tokens/public/.well-known/openid-configuration": {
       "get": {
         "operationId": "getPublicTokenOIDC",
@@ -395,6 +460,41 @@
           }
         }
       }
+    },
+    "/v1/access-tokens/portal-preview/.well-known/openid-configuration": {
+      "get": {
+        "operationId": "getPortalPreviewTokenOIDC",
+        "summary": "getPortalPreviewTokenOIDC",
+        "description": "OpenID Connect configuration for Access Token API a a portal preview identity provider\n\nNote: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to\nautomate the process of verifying JWT tokens.\n",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "responses": {
+          "200": {
+            "description": "OpenID Configuration",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "issuer": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview"
+                    },
+                    "jwks_uri": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -434,7 +534,8 @@
           "journey",
           "portal",
           "assume",
-          "app"
+          "app",
+          "portal_preview"
         ],
         "description": "Access token type",
         "example": "api"
@@ -447,6 +548,10 @@
         "type": "string",
         "description": "Portal ID for access token type \"portal\""
       },
+      "PortalUserId": {
+        "type": "string",
+        "description": "Portal User ID for access token type \"portal_preview\""
+      },
       "TokenParameters": {
         "anyOf": [
           {
@@ -463,6 +568,9 @@
           },
           {
             "$ref": "#/components/schemas/AppTokenParameters"
+          },
+          {
+            "$ref": "#/components/schemas/PortalPreviewTokenParameters"
           }
         ]
       },
@@ -484,6 +592,11 @@
           }
         ]
       },
+      "ReadOnly": {
+        "type": "boolean",
+        "description": "When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.",
+        "example": true
+      },
       "AccessTokenParameters": {
         "type": "object",
         "additionalProperties": false,
@@ -502,6 +615,9 @@
           },
           "expires_in": {
             "$ref": "#/components/schemas/ExpiresIn"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
@@ -573,6 +689,9 @@
           },
           "assignments": {
             "$ref": "#/components/schemas/Assignments"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
@@ -597,12 +716,41 @@
           },
           "expires_in": {
             "$ref": "#/components/schemas/ExpiresIn"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
           "name"
         ]
       },
+      "PortalPreviewTokenParameters": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "$ref": "#/components/schemas/AccessTokenName"
+          },
+          "token_type": {
+            "type": "string",
+            "enum": [
+              "portal_preview"
+            ]
+          },
+          "portal_id": {
+            "$ref": "#/components/schemas/PortalId"
+          },
+          "portal_user_id": {
+            "$ref": "#/components/schemas/PortalUserId"
+          }
+        },
+        "required": [
+          "name",
+          "portal_id",
+          "portal_user_id"
+        ]
+      },
       "AccessTokenItem": {
         "type": "object",
         "properties": {
@@ -625,9 +773,15 @@
           "portal_id": {
             "$ref": "#/components/schemas/PortalId"
           },
+          "portal_user_id": {
+            "$ref": "#/components/schemas/PortalUserId"
+          },
           "assignments": {
             "$ref": "#/components/schemas/Assignments"
           },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
+          },
           "last_used": {
             "type": "string",
             "format": "date",

package/definitions/app.json

@@ -2750,7 +2750,8 @@
               },
               "result": {
                 "type": "string",
-                "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
+                "deprecated": true,
+                "description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
               }
             },
             "required": [
@@ -2760,6 +2761,21 @@
             ],
             "additionalProperties": false
           },
+          "resolved": {
+            "type": "object",
+            "properties": {
+              "result": {
+                "type": "string",
+                "description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
+              }
+            },
+            "additionalProperties": false
+          },
           "use_static_ips": {
             "type": "boolean",
             "deprecated": true,
@@ -2832,7 +2848,8 @@
               },
               "result": {
                 "type": "string",
-                "description": "Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
+                "deprecated": true,
+                "description": "Deprecated. Use `resolved.result` instead. Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
               }
             },
             "required": [
@@ -2841,6 +2858,21 @@
             ],
             "additionalProperties": false
           },
+          "resolved": {
+            "type": "object",
+            "properties": {
+              "result": {
+                "type": "string",
+                "description": "Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
+              }
+            },
+            "additionalProperties": false
+          },
           "assignment_mode": {
             "type": "string",
             "enum": [
@@ -2953,11 +2985,16 @@
             "type": "object",
             "description": "Response to the call",
             "properties": {
-              "dataPath": {
+              "data_path": {
                 "type": "string",
                 "description": "Optional path to an array in the response. If specified and the path points to an array,\nthe hook will map over each item using 'Item' variable for interpolation.\nRelevant only if plausibility_mode is \"range\".\n",
                 "example": "data.results"
               },
+              "dataPath": {
+                "type": "string",
+                "deprecated": true,
+                "description": "Deprecated. Use `data_path` instead."
+              },
               "counter_identifiers": {
                 "description": "Counter identifier(s) used to match against the meter's counters.\nCan be a string (counter ID) or an object with counter properties.\nThe backend resolves this to meter_counter_id in the final response.\nRelevant only if plausibility_mode is \"range\".\n",
                 "type": "object",
@@ -2982,6 +3019,11 @@
                 "type": "string",
                 "description": "Lower allowed limit of the meter reading",
                 "example": "{{CallResponse.data.lower_limit}}"
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             },
             "additionalProperties": false
@@ -3081,9 +3123,19 @@
           "resolved": {
             "type": "object",
             "properties": {
-              "dataPath": {
+              "data_path": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "dataPath": {
+                "type": "string",
+                "deprecated": true,
+                "description": "Deprecated. Use `data_path` instead."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             },
             "additionalProperties": false
@@ -3182,9 +3234,19 @@
           "resolved": {
             "type": "object",
             "properties": {
-              "dataPath": {
+              "data_path": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "dataPath": {
+                "type": "string",
+                "deprecated": true,
+                "description": "Deprecated. Use `data_path` instead."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             },
             "additionalProperties": false
@@ -3273,6 +3335,17 @@
             ],
             "additionalProperties": false
           },
+          "resolved": {
+            "type": "object",
+            "properties": {
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
+              }
+            },
+            "additionalProperties": false
+          },
           "use_static_ips": {
             "type": "boolean",
             "deprecated": true,
@@ -3291,7 +3364,7 @@
         "additionalProperties": false
       },
       "PortalExtensionHookVisualizationMetadata": {
-        "description": "Hook that returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). It is invoked by the portal before fetching data, with the same context the data hook would receive, so that the discovery shape can vary per meter/contract. The expected response to the call is:\n  - 200 with a JSON body of shape:\n    {\n      \"type_options\": [\n        { \"id\": \"ht\", \"label\": { \"en\": \"High tariff\" }, \"aggregation_group\": \"consumption\", \"statistical_method\": \"sum\", \"unit\": \"kWh\" },\n        ...\n      ],\n      \"intervals\": [\"PT15M\", \"PT1H\", \"P1D\", \"P1M\"],\n      \"data_range\": { \"from\": \"2024-01-01T00:00:00Z\", \"to\": \"2026-05-01T00:00:00Z\" }\n    }\n  Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.\n  `aggregation_group` controls how types within a group are visually combined (depends on the per-type `statistical_method`):\n    - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.\n    - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.\n  All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.\nThe portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.\n",
+        "description": "Hook that returns runtime metadata describing how a visualization (consumption / price / cost chart) should be rendered for a given portal context (meter, contract, etc). It is invoked by the portal before fetching data, with the same context the data hook would receive, so that the discovery shape can vary per meter/contract. The expected response to the call is:\n  - 200 with a JSON body of shape:\n    {\n      \"type_options\": [\n        { \"id\": \"ht\", \"label\": { \"en\": \"High tariff\" }, \"aggregation_group\": \"consumption\", \"statistical_method\": \"sum\", \"unit\": \"kWh\", \"color\": \"primary\", \"precision\": 2 },\n        ...\n      ],\n      \"intervals\": [\"PT15M\", \"PT1H\", \"P1D\", \"P1M\"],\n      \"data_range\": { \"from\": \"2024-01-01T00:00:00Z\", \"to\": \"2026-05-01T00:00:00Z\" }\n    }\n  Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.\n  Each type option may also customize its rendering: `color` picks a Spark palette color (`primary`, `slate`, `mauve`, `orange`, `red`, `tomato`, `amber`, `green`, `blue`) used to draw the type's series; `precision` sets the number of decimal places to show for that type's values (axis labels, tooltips, summaries). Both are optional — the consumer falls back to its own defaults when they are omitted.\n  `aggregation_group` controls how types within a group are visually combined (depends on the per-type `statistical_method`):\n    - bar chart (`sum`): same-group types are stacked into a single bar (e.g. ht/nt summed into total consumption); different-group types render side-by-side.\n    - line chart (`min` / `average` / `max`): same-group types are rendered as an area chart; different-group types render as separate lines.\n  All fields are optional; the consumer falls back to its defaults for whatever the hook does not return.\nThe portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.\n",
         "type": "object",
         "properties": {
           "id": {
@@ -3353,9 +3426,19 @@
           "resolved": {
             "type": "object",
             "properties": {
-              "dataPath": {
+              "data_path": {
                 "type": "string",
                 "description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
+              },
+              "dataPath": {
+                "type": "string",
+                "deprecated": true,
+                "description": "Deprecated. Use `data_path` instead."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             },
             "additionalProperties": false
@@ -3454,9 +3537,19 @@
           "resolved": {
             "type": "object",
             "properties": {
-              "dataPath": {
+              "data_path": {
                 "type": "string",
                 "description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
+              },
+              "dataPath": {
+                "type": "string",
+                "deprecated": true,
+                "description": "Deprecated. Use `data_path` instead."
+              },
+              "error_message_path": {
+                "type": "string",
+                "description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
+                "example": "error.message"
               }
             },
             "additionalProperties": false

package/definitions/automation.json

@@ -1064,6 +1064,13 @@
               "$ref": "#/components/schemas/ActionSchedule"
             }
           },
+          "loops": {
+            "type": "array",
+            "description": "Loop scope definitions. Each loop has an id and a source_path resolved against the trigger entity at execution time. Actions referencing a loop's id via their loop_id property run once per item in the resolved array. Loop members must be contiguous in the actions array.\n",
+            "items": {
+              "$ref": "#/components/schemas/AutomationLoop"
+            }
+          },
           "actions": {
             "type": "array",
             "description": "The actions (nodes) of the automation flow",
@@ -1354,9 +1361,48 @@
           "schedule_id": {
             "type": "string",
             "description": "Schedule Id which indicates the schedule of the action"
+          },
+          "loop_id": {
+            "type": "string",
+            "description": "Id of a loop scope defined on the parent flow. When set, the action runs once per item resolved from the loop's source_path. All actions sharing the same loop_id must be contiguous in the actions array.\n"
           }
         }
       },
+      "AutomationLoop": {
+        "type": "object",
+        "description": "A loop scope on an automation flow.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Stable identifier referenced by AutomationActionConfig.loop_id",
+            "example": "loop_contracts"
+          },
+          "source_path": {
+            "type": "string",
+            "description": "Path resolved against the trigger entity to produce the array of iteration items. e.g. submission.steps[0]['Contracts'].\n",
+            "example": "submission.steps[0]['Contracts']"
+          },
+          "source_type": {
+            "type": "string",
+            "description": "How source_path is interpreted. 'journey-multi-select' is the v1 source type (journey card block with multi-select). Future source types (e.g. 'previous-action-outputs', 'entity-relation') will be added here.\n",
+            "enum": [
+              "journey-multi-select",
+              "previous-action-outputs",
+              "entity-relation"
+            ],
+            "default": "journey-multi-select"
+          },
+          "length": {
+            "type": "integer",
+            "description": "Maximum number of iterations. 0 / omitted = iterate the full resolved array.\n",
+            "minimum": 0
+          }
+        },
+        "required": [
+          "id",
+          "source_path"
+        ]
+      },
       "AutomationActionExecutionState": {
         "type": "object",
         "properties": {
@@ -1379,9 +1425,49 @@
           },
           "retry_strategy": {
             "$ref": "#/components/schemas/RetryStrategy"
+          },
+          "iterations": {
+            "type": "array",
+            "description": "For looped actions, an archive of completed iterations. The action's own execution_status / outputs / error_output always reflect the current (latest) iteration. The previous iteration's state is pushed here before the action is reset for the next pass.\n",
+            "items": {
+              "$ref": "#/components/schemas/AutomationActionIteration"
+            }
           }
         }
       },
+      "AutomationActionIteration": {
+        "type": "object",
+        "description": "A snapshot of a single completed pass through a looped action.",
+        "properties": {
+          "index": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Zero-based iteration index within the loop scope."
+          },
+          "execution_status": {
+            "$ref": "#/components/schemas/ExecutionStatus"
+          },
+          "started_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "ended_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "outputs": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "error_output": {
+            "$ref": "#/components/schemas/ErrorOutput"
+          }
+        },
+        "required": [
+          "index",
+          "execution_status"
+        ]
+      },
       "RetryStrategy": {
         "type": "string",
         "description": "different behaviors for retrying failed execution actions.",
@@ -3263,6 +3349,9 @@
             "type": "boolean",
             "description": "Result of the condition evaluation"
           },
+          "error_output": {
+            "$ref": "#/components/schemas/ErrorOutput"
+          },
           "statements": {
             "type": "array",
             "items": {
@@ -3433,6 +3522,20 @@
           },
           "workflow_context": {
             "$ref": "#/components/schemas/WorkflowExecutionContext"
+          },
+          "loops": {
+            "type": "array",
+            "description": "Loop scope definitions propagated from the flow onto the execution record. Each loop has an id and a source_path resolved against the trigger entity at execution time. Actions referencing a loop's id via their loop_id property run once per item in the resolved array.\n",
+            "items": {
+              "$ref": "#/components/schemas/AutomationLoop"
+            }
+          },
+          "loop_state": {
+            "type": "object",
+            "description": "Runtime iteration state, keyed by loop_id. Tracks the current_index and total for each active loop scope. Entries are removed once a loop exits.\n",
+            "additionalProperties": {
+              "$ref": "#/components/schemas/AutomationLoopState"
+            }
           }
         },
         "required": [
@@ -3444,6 +3547,23 @@
           "actions"
         ]
       },
+      "AutomationLoopState": {
+        "type": "object",
+        "properties": {
+          "current_index": {
+            "type": "integer",
+            "minimum": 0
+          },
+          "total": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "required": [
+          "current_index",
+          "total"
+        ]
+      },
       "WorkflowExecutionContext": {
         "type": "object",
         "required": [