Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Ionworks Studio home page

Support
Go to Studio
Go to Studio

Documentation

Guide

API Reference

Blog
Changelog
ionworks-schema
Python API
ionworksdata
ionworkspipeline
PyBaMM

API Reference

GET
List projects for an organization
POST
Create a new project within an organization, assigning creator as Project Admin
GET
Get a specific project by ID within an organization
DEL
Delete a project from an organization
PATCH
Update a project within an organization
POST
Add a user to a project or update their project role
DEL
Remove a user from a project
PATCH
Update a user's project role
GET
List models for an organization
POST
Create a new model within an organization
GET
Get a specific model by ID within an organization
DEL
Delete a model from an organization
PATCH
Update a model within an organization
POST
Add a custom variable to an existing model

Cell Specifications

GET
List cell instances for a cell specification
POST
Create a new cell instance for a cell specification
GET
List cell specifications for the current organization
POST
Create a new cell specification with nested component/material data
GET
Get a cell specification with nested component and material data
DEL
Delete a cell specification by id for the current organization
PATCH
Update a cell specification with nested component/material data

Cell Instances

GET
List cell measurements for a cell instance
POST
Create a properties-type measurement directly
POST
Initiate a signed URL upload for measurement data
GET
Get a specific cell instance by id
DEL
Delete a specific cell instance by id
PATCH
Update a specific cell instance by id

Cell Measurements

GET
List measurements by cell_specification_id
GET
List cell measurements for a project with full spec/instance data
GET
Get a cell measurement by id
DEL
Delete a specific cell measurement by id
PATCH
Update a cell measurement by id
GET
Get detailed information for a cell measurement
deprecated
GET
Get all steps for a cell measurement
GET
Get steps and cycle metrics in one call
GET
Get cycle metrics only for a cell measurement
GET
Get time series data for a measurement
GET
Download time series parquet file
GET
Download steps parquet file
GET
List files in a measurement
GET
Download a measurement file
POST
Confirm a signed URL upload and finalize the measurement

Simulations

GET
List Simulations
GET
Get Simulation Summary
GET
Get Simulation
GET
Get Simulation Result
GET
Get Simulation Cycles
POST
Create Simulation Batch With Template

parameterized_models

GET
List parameterized models for a cell specification
POST
Create a new parameterized model for the current cell specification
DEL
Delete a parameterized model
PATCH
Update a parameterized model
GET
Get Parameterized Model Parameter Values
GET
Get Parameterized Model Variable Names
GET
List parameterized models for a cell specification
POST
Create a new parameterized model for the current cell specification
DEL
Delete a parameterized model
PATCH
Update a parameterized model
GET
Get Parameterized Model Parameter Values
GET
Get Parameterized Model Variable Names

discovery

GET
Get Capabilities
GET
Get Data Schema
GET
Get Protocol Schema
GET
Get Project Schema
GET
Get Study Schema
GET
Get Model Schema
GET
Get Pybamm Models
POST
Validate Pybamm Model Config
GET
Get Parameterized Model Schema
GET
Get Optimization Schema
GET
Get Pipeline Schema
GET
Get Simple Pipeline Schema

Pipeline

GET
List user's pipelines
POST
Create a new pipeline
GET
Get pipeline metadata
GET
Get pipeline result
POST
Cancel a pipeline

simple_pipeline

GET
List SimplePipelines
POST
Create and submit a SimplePipeline
GET
Get SimplePipeline by ID
DEL
Delete a SimplePipeline
PATCH
Update SimplePipeline name/description
POST
Cancel a running SimplePipeline

protocols

POST
Validate Protocol Endpoint
POST
Convert Protocol Endpoint
POST
Find Input References Endpoint

users

GET
Get Current User Profile

jobs

GET
List Jobs
POST
Submit Job
GET
Get Job
GET
Get Job Metadata
POST
Cancel Job

optimization

GET
Get Optimization With Jobs
POST
Run Optimization Json Endpoint
GET
Get Optimization With Job
PATCH
Update Optimization
POST
Cancel Optimization

studies

GET
List studies for a project
POST
Create a new study
GET
Get a specific study by ID
DEL
Delete a study
PATCH
Update a study
POST
Assign a simulation to a study
DEL
Remove a simulation from a study
POST
Assign a measurement to a study
DEL
Remove a measurement from a study
GET
List measurements assigned to a study

Health check

GET
Health Check

curl --request GET \
  --url https://api.ionworks.com/search

{
  "results": [
    {
      "id": "<string>",
      "entity_type": "<string>",
      "name": "<string>",
      "project_id": "<string>"
    }
  ],
  "query": "<string>"
}

Search

Search across all entity types within the authenticated organization.

Applies ilike substring matching on name fields and Postgres prefix tsquery (to_tsquery with :*) FTS on free-form text fields (description, notes).

Parameters

q : str Search query, minimum 2 characters. per_type : int Maximum number of results to return per entity type (1–20).

Returns

SearchResponse Combined results from all searchable entity types.

curl --request GET \
  --url https://api.ionworks.com/search

{
  "results": [
    {
      "id": "<string>",
      "entity_type": "<string>",
      "name": "<string>",
      "project_id": "<string>"
    }
  ],
  "query": "<string>"
}

Query Parameters

string

required

Search query (minimum 2 characters)

Minimum string length: 2

per_type

integer

default:5

Maximum results per entity type

Required range: 1 <= x <= 20

Response

Successful Response

Response from the global search endpoint.

results

SearchResult · object[]

required

Show child attributes

query

string

required

Was this page helpful?

⌘I

github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.

Contact support