Skip to main content
Run validation simulations for measurements
curl --request POST \
  --url https://api.ionworks.com/projects/{project_id}/studies/{study_id}/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "measurement_ids": [
    "<string>"
  ],
  "parameterized_model_id": "<string>",
  "cell_specification_id": "<string>",
  "start_step": 123,
  "end_step": 123,
  "initial_voltage": 123,
  "initial_soc": 123
}
'
{
  "validations": [
    {
      "measurement_id": "<string>",
      "simulation_id": "<string>",
      "job_id": "<string>"
    }
  ],
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ],
  "skipped": [
    "<string>"
  ]
}

Path Parameters

study_id
string
required
project_id
string
required

Body

application/json

Payload for the POST validate endpoint.

measurement_ids
string[]
required

IDs of measurements to validate

Minimum array length: 1
parameterized_model_id
string
required

ID of the parameterized model to simulate

cell_specification_id
string
required

ID of the cell specification (for model ownership verification)

start_step
integer | null

First step index to include (inclusive)

end_step
integer | null

Last step index to include (inclusive)

initial_voltage
number | null

Custom initial voltage [V]. Overrides auto-detection.

initial_soc
number | null

Custom initial SOC (0-1). Overrides voltage-based init.

Response

Successful Response

Aggregated result of a batch validation request.

validations
ValidationResult · object[]
errors
ValidationError · object[]
skipped
string[]

Measurement IDs skipped because an identical validation already exists