---
updatedAt: 2026-06-18T21:25:08.000Z
agentTools:
  siteIndex: https://developers.liveramp.com/llms.txt
  projectIndex: https://developers.liveramp.com/clean-room-api/llms.txt
---

# Preview Flow Run Parameters

Returns the expected runtime and partition parameters for each question node that would be included in a flow run, without actually creating a run. Accepts the same request shape as Create Cleanroom Flow Run. If parentFlowRunId is set on the request, it is treated as a replay scenario.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "v1.0.0",
    "title": "External APIs for Customer Integration",
    "description": "APIs to create and fetch Clean Room and related details from LiveRamp (previously Habu) for Customer Integration.",
    "contact": {
      "name": "LiveRamp (previously Habu)",
      "url": "https://liveramp.com/",
      "email": "platform_admin@habu.com"
    }
  },
  "security": [
    {
      "application": []
    }
  ],
  "paths": {
    "/cleanrooms/{cleanroomId}/cleanroom-flows/{cleanroomFlowId}/preview-flow-run-parameters": {
      "post": {
        "summary": "Preview Flow Run Parameters",
        "operationId": "previewFlowRunParameters",
        "description": "Returns the expected runtime and partition parameters for each question node that would be included in a flow run, without actually creating a run. Accepts the same request shape as Create Cleanroom Flow Run. If parentFlowRunId is set on the request, it is treated as a replay scenario.",
        "parameters": [
          {
            "name": "cleanroomId",
            "in": "path",
            "description": "Cleanroom ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cleanroomFlowId",
            "in": "path",
            "description": "Cleanroom Flow ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PreviewFlowRunParametersInput"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successfully retrieved the preview of flow run parameters.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PreviewFlowRunParametersResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "tags": [
          "Cleanroom Flow Runs"
        ]
      }
    }
  },
  "components": {
    "responses": {
      "BadRequest": {
        "description": "Bad Request - Incorrect syntax or request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "NotFound": {
        "description": "The specified resource was not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Authorization information was missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/ReturnObject"
            }
          }
        }
      }
    },
    "schemas": {
      "NodeDatasetAssignment": {
        "type": "object",
        "properties": {
          "nodeIdentifier": {
            "type": "string",
            "description": "Node display ID or name"
          },
          "datasets": {
            "type": "array",
            "description": "Dataset assignments for this node",
            "items": {
              "$ref": "#/components/schemas/DatasetAssignment"
            }
          }
        }
      },
      "DatasetAssignment": {
        "type": "object",
        "properties": {
          "datasetName": {
            "type": "string",
            "description": "Dataset name (will be resolved to ID)"
          },
          "datasetMacro": {
            "type": "string",
            "description": "Dataset macro/type"
          },
          "organizationName": {
            "type": "string",
            "description": "Organization name from stakeholders list (will be resolved to ownership)"
          },
          "fieldMappings": {
            "type": "array",
            "description": "Field mappings using field names",
            "items": {
              "$ref": "#/components/schemas/FieldMapping"
            }
          }
        }
      },
      "FieldMapping": {
        "type": "object",
        "properties": {
          "questionFieldName": {
            "type": "string",
            "description": "Question field name in the node"
          },
          "datasetFieldName": {
            "type": "string",
            "description": "Dataset field name to map to"
          }
        }
      },
      "ParameterType": {
        "type": "string",
        "enum": [
          "RUN_TIME_PARAMETER",
          "PARTITION_PARAMETER",
          "ARTIFACT_FILE_METADATA",
          "PARAMETER_UNKNOWN"
        ]
      },
      "ParameterInfo": {
        "type": "object",
        "properties": {
          "Id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "index": {
            "type": "integer"
          },
          "fieldType": {
            "$ref": "#/components/schemas/UnhygienixFieldType"
          },
          "parameterType": {
            "$ref": "#/components/schemas/ParameterType"
          }
        }
      },
      "UnhygienixFieldType": {
        "type": "string",
        "enum": [
          "FIELD_TYPE_UNKNOWN",
          "INTEGER",
          "STRING",
          "DATE",
          "TIMESTAMP",
          "DOUBLE",
          "BIGINT",
          "BOOLEAN",
          "DECIMAL",
          "LONG"
        ]
      },
      "PreviewFlowRunParametersInput": {
        "type": "object",
        "description": "Input for previewing flow run parameters",
        "properties": {
          "branches": {
            "type": "string",
            "description": "Branch names to filter flow execution (comma-separated)"
          },
          "excludeNodesWithoutTags": {
            "type": "boolean",
            "description": "Exclude nodes without tags when branch filtering is enabled"
          },
          "ignoreParentChildRule": {
            "type": "boolean",
            "description": "Ignore parent-child dependency rules"
          },
          "includeMismatchingTaggedNodes": {
            "type": "boolean",
            "description": "Include unmatched nodes when branch filtering is enabled"
          },
          "datasetAssignments": {
            "type": "array",
            "description": "Dataset assignments for each node (used to derive partition parameters)",
            "items": {
              "$ref": "#/components/schemas/NodeDatasetAssignment"
            }
          },
          "parentFlowRunId": {
            "type": "string",
            "description": "When set, preview is treated as a replay of this parent flow run"
          }
        }
      },
      "PreviewFlowRunParametersResponse": {
        "type": "object",
        "properties": {
          "nodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FlowNodeParameterPreview"
            }
          }
        }
      },
      "FlowNodeParameterPreview": {
        "type": "object",
        "description": "Per-node parameter preview containing question metadata and expected parameters",
        "properties": {
          "nodeId": {
            "type": "string",
            "description": "Internal node UUID"
          },
          "nodeIdentifier": {
            "type": "string",
            "description": "Display label of the node"
          },
          "questionName": {
            "type": "string",
            "description": "Title of the question associated with this node"
          },
          "questionVersion": {
            "type": "integer",
            "description": "Version of the question"
          },
          "nodeLevel": {
            "type": "integer",
            "description": "DAG depth of the node in the flow"
          },
          "parameters": {
            "type": "array",
            "description": "Combined list of runtime and partition parameters",
            "items": {
              "$ref": "#/components/schemas/ParameterInfo"
            }
          }
        }
      },
      "ReturnObject": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "application": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://api.habu.com/v1/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "description": "External APIs for Customer Integration",
      "url": "https://api.habu.com/v1/"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  }
}
```