> ## 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.

# Create a parameterized model for a cell specification or project

> Create a parameterized model, under a cell specification or in a project.

Via ``/cells/{cell_spec_id}/parameterized_models`` the model belongs to that
cell specification, whose capacity and voltage cut-offs override the
parameter set's. Via ``/parameterized_models`` with ``project_id`` in the body
it has no cell specification and keeps the parameter set's own values.

Raises
------
BadRequestError
    If neither scope is given, or ``project_id`` names a different project
    than the cell specification's.
NotFoundError
    If the cell specification, project, or model cannot be read.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json post /parameterized_models
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /parameterized_models:
    post:
      tags:
        - parameterized_models
      summary: Create a parameterized model for a cell specification or project
      description: >-
        Create a parameterized model, under a cell specification or in a
        project.


        Via ``/cells/{cell_spec_id}/parameterized_models`` the model belongs to
        that

        cell specification, whose capacity and voltage cut-offs override the

        parameter set's. Via ``/parameterized_models`` with ``project_id`` in
        the body

        it has no cell specification and keeps the parameter set's own values.


        Raises

        ------

        BadRequestError
            If neither scope is given, or ``project_id`` names a different project
            than the cell specification's.
        NotFoundError
            If the cell specification, project, or model cannot be read.
      operationId: create_parameterized_model_parameterized_models_post
      parameters:
        - name: cell_spec_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Cell Spec Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateParameterizedModelBody'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CreateParameterizedModelBody:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
          default: ''
        model_id:
          type: string
          title: Model Id
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
          default: {}
        simulation_settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Simulation Settings
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
          description: >-
            Project for a model with no cell specification; under one, it must
            match the specification's project.
      type: object
      required:
        - name
        - model_id
      title: CreateParameterizedModelBody
      description: >-
        Request body for creating a parameterized model.


        The frontend sends all parameter values directly - no library presets or
        BPX.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.