> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Validate Parameters

> Validate parameterized model parameters against reference values.

For each known reference parameter, computes the value implied by the
supplied parameter set, the reference value, the percentage deviation,
a status (``success``/``warning``/``error``), an explanatory message,
and an optional autofix that would close the gap.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json post /parameterized_models/validate-parameters
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /parameterized_models/validate-parameters:
    post:
      tags:
        - parameterized_models
      summary: Validate Parameters
      description: |-
        Validate parameterized model parameters against reference values.

        For each known reference parameter, computes the value implied by the
        supplied parameter set, the reference value, the percentage deviation,
        a status (``success``/``warning``/``error``), an explanatory message,
        and an optional autofix that would close the gap.
      operationId: validate_parameters_parameterized_models_validate_parameters_post
      parameters:
        - name: cell_spec_id
          in: query
          required: true
          schema:
            type: string
            title: Cell Spec Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateParametersBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateParametersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidateParametersBody:
      properties:
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
        model_id:
          type: string
          title: Model Id
      type: object
      required:
        - parameters
        - model_id
      title: ValidateParametersBody
    ValidateParametersResponse:
      properties:
        results:
          additionalProperties:
            $ref: '#/components/schemas/ParameterValidationResult'
          type: object
          title: Results
          description: Validation results keyed by parameter name (e.g. 'Capacity [Ah]').
      type: object
      title: ValidateParametersResponse
      description: Per-parameter validation results keyed by parameter name.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ParameterValidationResult:
      properties:
        value:
          type: number
          title: Value
          description: Value computed from the current parameter set.
        reference:
          type: number
          title: Reference
          description: Reference value to compare against.
        deviation:
          type: number
          title: Deviation
          description: Absolute percentage deviation of value from reference.
        status:
          type: string
          enum:
            - success
            - warning
            - error
          title: Status
          description: >-
            Validation status: success (≤10% deviation), warning (≤50%), or
            error (>50%).
        message:
          type: string
          title: Message
          description: Human-readable description of the check.
        autofix:
          additionalProperties: true
          type: object
          title: Autofix
          description: >-
            Parameter overrides that would bring `value` in line with
            `reference`. Empty when no autofix is available.
      type: object
      required:
        - value
        - reference
        - deviation
        - status
        - message
      title: ParameterValidationResult
      description: Validation outcome for a single parameter against its reference value.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````