API Reference
- GETList projects for an organization
- POSTCreate a new project within an organization, assigning creator as Project Admin
- GETGet a specific project by ID within an organization
- DELDelete a project from an organization
- PATCHUpdate a project within an organization
- GETList models for an organization
- POSTCreate a new model within an organization
- GETGet a specific model by ID within an organization
- DELDelete a model from an organization
- PATCHUpdate a model within an organization
- POSTAdd a custom variable to an existing model
Cell Specifications
- GETList cell instances for a cell specification
- POSTCreate a new cell instance for a cell specification
- GETList cell specifications for the current organization
- POSTCreate a new cell specification with nested component/material data
- GETGet a cell specification with nested component and material data
- DELDelete a cell specification by id for the current organization
- PATCHUpdate a cell specification with nested component/material data
Cell Instances
Cell Measurements
- GETList measurements by cell_specification_id
- GETList cell measurements for a project with full spec/instance data
- GETGet a cell measurement by id
- DELDelete a specific cell measurement by id
- PATCHUpdate a cell measurement by id
- GETGet detailed information for a cell measurementdeprecated
- GETGet all steps for a cell measurement
- GETGet steps and cycle metrics in one call
- GETGet cycle metrics only for a cell measurement
- GETGet time series data for a measurement
- GETDownload time series parquet file
- GETDownload steps parquet file
- GETList files in a measurement
- GETDownload a measurement file
- POSTConfirm a signed URL upload and finalize the measurement
Simulations
parameterized_models
- GETList parameterized models for a cell specification
- POSTCreate a new parameterized model for the current cell specification
- PATCHUpdate a parameterized model
- GETGet Parameterized Model Parameter Values
- GETGet Parameterized Model Variable Names
- GETList parameterized models for a cell specification
- POSTCreate a new parameterized model for the current cell specification
- PATCHUpdate a parameterized model
- GETGet Parameterized Model Parameter Values
- GETGet Parameterized Model Variable Names
discovery
Pipeline
optimization
studies
Health check
Remove a simulation from a study
curl --request DELETE \
--url https://api.ionworks.com/projects/{project_id}/studies/{study_id}/simulations/{simulation_id}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}studies
Remove a simulation from a study
Remove a simulation assignment from a study.
Remove a simulation from a study
curl --request DELETE \
--url https://api.ionworks.com/projects/{project_id}/studies/{study_id}/simulations/{simulation_id}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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.
Was this page helpful?
⌘I