Cell Specifications

Create a new cell specification with nested component/material data

Create a new cell specification with nested component and material data.

Materials and components are automatically upserted based on uniqueness:

Materials: unique on (organization_id, name, manufacturer)
Components: unique on (organization_id, component_type, material_id, properties)

Example request body:

{
    "name": "NCM622/Graphite Coin Cell",
    "capacity": 0.002,
    "lower_voltage_cutoff": 2.5,
    "upper_voltage_cutoff": 4.2,
    "form_factor": "R2032",
    "anode": {
        "properties": {"diameter_mm": 15, "thickness_um": 23},
        "material": {"name": "Graphite", "manufacturer": "Customcells"}
    },
    "cathode": {
        "properties": {"diameter_mm": 14, "thickness_um": 22},
        "material": {
            "name": "NCM622",
            "definition": {"formula": "LiNi0.6Co0.2Mn0.2O2"}
        }
    }
}

post/cell_specifications

Request body

namestring required

Name of the cell specification

form_factorstring nullable

Form factor (e.g., R2032, 18650, pouch)

manufacturerstring nullable

Who assembled/manufactured the cell

propertiesobject nullable

Non-electrical design properties (assembly_method, etc.)

sourceobject nullable

Source/provenance info: doi, license, publication_date, citation, creator_name, creator_orcid

notesstring nullable

Optional notes about the cell specification

project_idstring required

Project to associate with

Response

Successful Response

namestring required

Name of the cell specification

form_factorstring nullable

Physical form factor. Common values: '18650', '21700', 'R2032' (coin cell), 'pouch', 'prismatic', 'cylindrical'.

manufacturerstring nullable

Who assembled/manufactured the cell

anode_idstring nullable

ID of the anode component

cathode_idstring nullable

ID of the cathode component

electrolyte_idstring nullable

ID of the electrolyte component

separator_idstring nullable

ID of the separator component

case_idstring nullable

ID of the case component

propertiesobject nullable

Other design-level properties that are not electrical ratings and not tied to a specific component — e.g. assembly method, overall cell dimensions, mass, target thickness. Numeric values must use the Quantity format ({'value': ..., 'unit': ...}).

sourceobject nullable

Provenance of the design. Typical keys: 'doi', 'citation', 'publication_date' (ISO 8601), 'license', 'creator_name', 'creator_orcid'. Lives on the specification (not the instance) because it describes the published design.

notesstring nullable

Free-text notes about the cell specification

idstring required

Unique identifier for the cell specification

organization_idstring required

Organization ID of the cell specification

project_idstring required

Project this cell specification belongs to

created_atstring date-time nullable

When this specification was created

updated_atstring date-time nullable

When this specification was last modified

created_bystring nullable

User ID of the user who created this specification

created_by_emailstring nullable

Email of the user who created this specification

instance_idsobject[] nullable

List of instance IDs associated with the cell specification

default_parameterized_model_idstring nullable

ID of the parameterized model marked as this specification's default model, or None if unset.

Changes

No recorded changes to this endpoint across all 1 revision of this API.