---
title: "Create a new model within an organization"
method: POST
path: "/models"
---

# Create a new model within an organization

`POST /models`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/models`
- Auth: none declared

Create a new model in the specified organization.

## Request body

- CreateModel: Model for creating a new model.
  - `name` string, required: The name of the model.
  - `description` string, nullable: An optional description for the model.
  - `pybamm_version` string, nullable: PyBaMM version used for this model. If not provided, will be read from pybamm.__version__.
  - `chemistry` 'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic': Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).
  - `simulation_settings` object, nullable: Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.
  - `project_id` string, uuid, required: Project to create the model in. Must belong to the current organization.
  - `config` object, required: Model configuration stored as JSON.

## Response `201`

Successful Response

- Model: Model representing a model as returned by the API (without config).
  - `name` string, required: The name of the model.
  - `description` string, nullable: An optional description for the model.
  - `pybamm_version` string, nullable: PyBaMM version used for this model. If not provided, will be read from pybamm.__version__.
  - `chemistry` 'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic': Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).
  - `simulation_settings` object, nullable: Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.
  - `project_id` string, nullable: Project this model belongs to. None only for the shared system catalog.
  - `id` string, required: The unique identifier for the model.
  - `user_id` string, nullable: The ID of the user who created the model. None once that account is deleted.
  - `organization_id` string, required: The ID of the organization this model belongs to.
  - `source_model_id` string, nullable: For a project's copy of a system model, the system model it was copied from. None for a model the project made itself.
  - `created_by_email` string, nullable: Email of the user who created the model.
  - `created_at` string, date-time, required: Timestamp of when the model was created.
  - `updated_at` string, date-time, required: Timestamp of when the model was last updated.
  - `is_custom_model` boolean, required: Check if this is a custom model (has compressed model data).

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-20** `4185f624bbb8`: 3 breaking, 2 info
  - added the new required request property `project_id`
  - the response property `user_id` became optional for the status `201`
  - response property `user_id` list-of-types was widened by adding types `null` to media type `application/json` of response `201`
  - added the optional property `project_id` to the response with the `201` status
  - …1 more

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/models/post.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)