> ## Documentation Index > Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a pipeline variant's run inputs > Inspect the effective manual-run input contract for a pipeline version and variant. GET /pipeline-versions/{id}/run-inputs in the Ravion API reference. ## OpenAPI ````yaml https://api.ravion.com/openapi.yaml get /pipeline-versions/{id}/run-inputs openapi: 3.0.0 info: title: Ravion version: 0.0.0 servers: - url: https://api.ravion.com security: - BearerAuth: [] tags: - name: Projects - name: Environments - name: FeatureFlags - name: Pipelines - name: PipelineRuns - name: TerraformResources - name: TerraformExecutionSummaries - name: PipelineStepExecutions - name: AwsCloudWatch - name: PipelineVersions - name: Organizations - name: Stacks - name: StackWorkspaces - name: Auth - name: OAuth - name: User - name: Health - name: Memberships - name: ServiceAccounts - name: Integrations - name: AwsDefaultNetworks - name: AwsAccounts - name: ApiKeys - name: AwsAmp - name: EksPrometheus - name: EksLoki - name: ExecutionEnvironments - name: ModuleDefinitions - name: ModuleCategories - name: ModuleVersions - name: ModuleInstances - name: DefaultValueDefinitions - name: DefaultValues - name: CodeSources - name: Github - name: GitHub Actions - name: Gitlab - name: Git - name: Values - name: Deployments - name: DeploymentResources - name: InfrastructureEvents - name: WebSocket - name: Domains - name: AcmCertificates - name: Describe - name: Reports - name: BillingPlans - name: BillingAccounts - name: BillingCycles - name: BillingUsageSummaries - name: BillingAddOns - name: BillingInvoices - name: Authorization paths: /pipeline-versions/{id}/run-inputs: get: tags: - PipelineVersions summary: Get a pipeline variant's run inputs description: >- Inspect the effective manual-run input contract for a pipeline version and variant. Inputs with source 'variant' must be omitted from createPipelineRun, even if the submitted value matches. Caller inputs include their defaults and validation constraints. Pass the returned pipelineVersionId and variantId when creating the run. operationId: GetPipelineVersionRunInputs parameters: - description: Pipeline version ID in: path name: id required: true schema: type: string - description: Variant to run in: query name: variantId required: true schema: type: string responses: '200': content: application/json: schema: additionalProperties: false properties: data: $ref: '#/components/schemas/PipelineVersionRunInputs' required: - data type: object description: The request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: The request is invalid or malformed. '401': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: You are not authenticated '403': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: You do not have permission to access this resource. '404': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: The server cannot find the requested resource. '422': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: Client error '500': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: Server error components: schemas: PipelineVersionRunInputs: additionalProperties: false properties: inputs: items: $ref: '#/components/schemas/PipelineVersionRunInput' type: array pipelineId: type: string pipelineVersionId: description: >- Pass this version ID when creating a run to use exactly this contract. type: string variantId: type: string required: - pipelineId - pipelineVersionId - variantId - inputs type: object Errors.UserFacingErrorData: additionalProperties: false description: |- User-facing error presentation data. This is what the API returns to the frontend after formatting ErrorData using CEL templates from the error registry. Used for both: - Error fields on domain models (e.g., PipelineRun.error) - API error response bodies (HTTP 4xx/5xx responses) properties: action: allOf: - $ref: '#/components/schemas/Errors.Action' description: Optional action to help resolve the error code: description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND" type: string description: description: Additional description with more details type: string details: description: Structured details rendered as user-facing sections. items: $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection' type: array isInternal: description: >- Indicates whether this error is internal (only set when ShowInternal=true). This allows SUPERADMINs to identify internal errors while viewing full details. type: boolean message: description: Main error message (required) type: string metadata: additionalProperties: {} description: >- Error params/metadata. Stripped for internal errors unless superadmin. type: object requestId: description: Request ID for correlating errors with server logs. type: string required: - code - message type: object PipelineVersionRunInput: additionalProperties: false properties: definition: allOf: - $ref: '#/components/schemas/Pipeline.PipelineInputDefinition' description: >- Original input definition, including its type, default and validation constraints. requiredFromCaller: description: >- True only when the caller must supply a value: required, with no default or variant value. type: boolean source: $ref: '#/components/schemas/PipelineVersion.RunInputSource' required: - definition - source - requiredFromCaller type: object Errors.Action: additionalProperties: false description: Action to help user resolve the error properties: label: description: Button/link label text type: string url: description: URL to navigate to for resolution type: string required: - label - url type: object Errors.UserFacingErrorDetailSection: additionalProperties: false description: Structured user-facing error detail section. properties: items: description: List of detail values for this section. items: type: string type: array object: additionalProperties: {} description: Structured detail payload for object rendering. type: object render: description: Rendering hint for clients. Valid values are list or object. type: string title: description: Detail section title shown in the UI. type: string required: - title - render type: object Pipeline.PipelineInputDefinition: description: Union of all pipeline input definitions, discriminated by `type`. discriminator: mapping: boolean: '#/components/schemas/Pipeline.PipelineBooleanInputDefinition' number: '#/components/schemas/Pipeline.PipelineNumberInputDefinition' object: '#/components/schemas/Pipeline.PipelineObjectInputDefinition' string: '#/components/schemas/Pipeline.PipelineStringInputDefinition' string_array: '#/components/schemas/Pipeline.PipelineStringArrayInputDefinition' text: '#/components/schemas/Pipeline.PipelineTextInputDefinition' propertyName: type oneOf: - $ref: '#/components/schemas/Pipeline.PipelineStringInputDefinition' - $ref: '#/components/schemas/Pipeline.PipelineTextInputDefinition' - $ref: '#/components/schemas/Pipeline.PipelineObjectInputDefinition' - $ref: '#/components/schemas/Pipeline.PipelineStringArrayInputDefinition' - $ref: '#/components/schemas/Pipeline.PipelineNumberInputDefinition' - $ref: '#/components/schemas/Pipeline.PipelineBooleanInputDefinition' type: object PipelineVersion.RunInputSource: enum: - caller - variant type: string Pipeline.PipelineBooleanInputDefinition: additionalProperties: false description: Boolean pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: false Optional type: boolean description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "Run in dry-run mode without deploying" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: dry_run Required minLength: 1 type: string required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: boolean Required enum: - boolean type: string required: - id - type type: object Pipeline.PipelineNumberInputDefinition: additionalProperties: false description: Number pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: 2 Optional format: int32 type: integer description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "Number of replicas to run" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: replicas Required minLength: 1 type: string max: description: |- Maximum allowed value (inclusive) Example: max: 10 Optional format: int32 type: integer min: description: |- Minimum allowed value (inclusive) Example: min: 1 Optional format: int32 type: integer required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: number Required enum: - number type: string values: description: |- Dropdown options restricting allowed values Example: values: - value: 1 label: "Single" - value: 3 label: "HA" Optional items: $ref: '#/components/schemas/Module.NumberValueItem' type: array x-schema-patch-keys: - value x-schema-patch-topology: map required: - id - type type: object Pipeline.PipelineObjectInputDefinition: additionalProperties: false description: Object pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: {} Optional description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "Object configuration overrides" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: config_overrides Required minLength: 1 type: string required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: object Required enum: - object type: string required: - id - type type: object Pipeline.PipelineStringInputDefinition: additionalProperties: false description: String pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: staging Optional type: string description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "Target deployment environment" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: environment Required minLength: 1 type: string patterns: description: |- Regex patterns the value must match Example: patterns: - pattern: "^[a-z-]+$" message: "Lowercase letters and dashes only" Optional items: $ref: '#/components/schemas/Module.ValidationPattern' type: array x-schema-patch-keys: - pattern x-schema-patch-topology: map required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: string Required enum: - string type: string values: description: |- Dropdown options restricting allowed values Example: values: - value: us-east-1 label: US East - value: eu-west-1 label: EU West Optional items: $ref: '#/components/schemas/Module.StringValueItem' type: array x-schema-patch-keys: - value x-schema-patch-topology: map required: - id - type type: object Pipeline.PipelineStringArrayInputDefinition: additionalProperties: false description: String array pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: [us-east-1, eu-west-1] Optional items: type: string type: array description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "AWS regions to deploy to" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: regions Required minLength: 1 type: string patterns: description: |- Regex patterns each array element must match Example: patterns: - pattern: "^[a-z]+-[a-z]+-[0-9]+$" message: "Must be a valid AWS region" Optional items: $ref: '#/components/schemas/Module.ValidationPattern' type: array x-schema-patch-keys: - pattern x-schema-patch-topology: map required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: string_array Required enum: - string_array type: string required: - id - type type: object Pipeline.PipelineTextInputDefinition: additionalProperties: false description: Text pipeline input definition properties: default: description: |- Default value used when no value is provided at runtime Example: default: "No release notes provided" Optional type: string description: description: |- Human-readable description shown in the UI when running the pipeline Example: description: "Release notes for this deployment" Optional type: string id: description: >- Unique identifier for this input — used in << pipeline.input.key >> templates Example: key: release_notes Required minLength: 1 type: string patterns: description: |- Regex patterns the value must match Example: patterns: - pattern: ".{10,}" message: "Must be at least 10 characters" Optional items: $ref: '#/components/schemas/Module.ValidationPattern' type: array x-schema-patch-keys: - pattern x-schema-patch-topology: map required: default: true description: |- Whether this input must be provided when running the pipeline Example: required: false Optional — defaults to true type: boolean type: description: |- Input type — determines the field widget and validation rules Example: type: text Required enum: - text type: string required: - id - type type: object Module.NumberValueItem: additionalProperties: false description: |- A selectable option with a numeric value. Used in number input validation.values arrays. properties: description: description: |- Extra detail shown alongside the option Example: description: Recommended for US-based users Optional type: string group_label: description: |- Groups options under a shared heading in the dropdown Example: group_label: North America Optional type: string label: description: |- Text shown in the dropdown — defaults to value if omitted Example: label: US East (N. Virginia) Optional type: string show_when: allOf: - $ref: '#/components/schemas/Module.ShowWhen' description: |- Only show this option when another field has a specific value Example: show_when: size_class: large Optional value: description: |- Actual number sent to Terraform when this option is selected Example: value: 4 Required format: int32 type: integer required: - value type: object Module.ValidationPattern: additionalProperties: false description: A regex pattern with an error message for validation properties: message: description: |- Error shown to the user when validation fails Example: message: Must contain only lowercase letters, numbers, and hyphens Required type: string pattern: description: |- JavaScript regex the input must match Example: pattern: ^[a-z0-9-]+$ Required type: string required: - pattern - message type: object Module.StringValueItem: additionalProperties: false description: |- A selectable option with a string value. Used in string input validation.values arrays. properties: description: description: |- Extra detail shown alongside the option Example: description: Recommended for US-based users Optional type: string group_label: description: |- Groups options under a shared heading in the dropdown Example: group_label: North America Optional type: string label: description: |- Text shown in the dropdown — defaults to value if omitted Example: label: US East (N. Virginia) Optional type: string show_when: allOf: - $ref: '#/components/schemas/Module.ShowWhen' description: |- Only show this option when another field has a specific value Example: show_when: package_type: Image Optional value: description: |- Actual value sent to Terraform when this option is selected Example: value: us-east-1 Required type: string required: - value type: object Module.ShowWhen: additionalProperties: $ref: '#/components/schemas/Module.ShowWhenCondition' description: >- Conditional visibility mapping; array source values support contains and contains-all matching. Keys are property names, values are the expected values or conditions. The property is shown only when all conditions are met. Example: region: us-east-1 advanced: true build_type: not: disabled type: object Module.ShowWhenCondition: anyOf: - $ref: '#/components/schemas/Module.ShowWhenComparableValue' - $ref: '#/components/schemas/Module.ShowWhenNotCondition' description: A show_when condition. Module.ShowWhenComparableValue: anyOf: - $ref: '#/components/schemas/Module.ShowWhenValue' - items: $ref: '#/components/schemas/Module.ShowWhenValue' type: array description: >- Value or values to compare against in a show_when condition; arrays mean membership for scalar sources and contains-all for array sources. When the source value is scalar, an array condition matches any listed value. When the source value is an array, a scalar condition matches if the array contains that value. When the source value is an array, an array condition matches if the array contains all listed values. Module.ShowWhenNotCondition: additionalProperties: false description: Negated show_when condition. properties: not: allOf: - $ref: '#/components/schemas/Module.ShowWhenComparableValue' description: >- Show the property only when the source value does not match this condition. Example: not: disabled Required required: - not type: object Module.ShowWhenValue: anyOf: - type: string - format: int32 type: integer - type: boolean description: |- Value that can be used in a show_when condition. Supports string, number, or boolean values for comparison. securitySchemes: BearerAuth: scheme: Bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.