Projects API - Ionworks Studio

The ionworks-api Python package provides a sub-client for managing projects programmatically. For installation and authentication, see the Python API client page.

Listing projects

from ionworks import Ionworks

client = Ionworks()

# List all projects
projects = client.project.list()
for project in projects:
    print(f"{project.name} (ID: {project.id})")

# Filter by name (case-insensitive substring match)
projects = client.project.list(name="NMC")

# Paginate results
projects = client.project.list(limit=10, offset=20)
print(f"Showing {projects.count} of {projects.total} projects")

Supported filters: name, description, created_at, updated_at (each with _gt / _lt variants for ranges), order_by, order. Filters and sort parameters are applied server-side, so you can page through large project lists without fetching every row.

Projects have no created_by_email filter — the projects table records no creator, so there is nothing to match against. Use client.model.list() or another resource if you need to filter by the user who created a record.

Getting a project

project = client.project.get("your-project-id")
print(f"{project.name}: {project.description}")

Creating a project

project = client.project.create({
    "name": "NMC622 Characterization",
    "description": "Parameter identification for NMC622/Graphite cells",
})
print(f"Created project: {project.id}")

Updating a project

project = client.project.update("your-project-id", {
    "name": "NMC622 Characterization v2",
    "description": "Updated description",
})

Deleting a project

client.project.delete("your-project-id")

You can find the ID for any resource from the Ionworks Studio web app. The ID is displayed in the URL when you navigate to a resource’s detail page.

⌘I