Skip to main content
Upload a material property dataset
curl --request POST \
  --url https://api.ionworks.com/material_property_datasets \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>' \
  --form 'material_id=<string>' \
  --form 'project_id=<string>' \
  --form 'name=<string>' \
  --form 'columns=<string>' \
  --form no_header=false
{
  "material_id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "columns": [
    {
      "name": "<string>",
      "source_column_index": 123,
      "unit": ""
    }
  ],
  "id": "<string>",
  "organization_id": "<string>",
  "storage_path": "<string>",
  "data_version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "original_path": "<string>",
  "nan_counts": {},
  "no_header": false,
  "created_by": "<string>"
}

Body

multipart/form-data
​
file
string
required
​
material_id
string
required
​
project_id
string
required
​
name
string
required

User-provided dataset name

​
columns
string
required

JSON array of column specs: [{"name": "c_e", "unit": "mol/L"}, ...]

​
no_header
boolean
default:false

Set to true when the CSV has no header row. Each column spec must include source_column_index to identify its position in the file.

Response

Successful Response

Material property dataset record as returned by the API.

​
material_id
string
required

ID of the parent material

​
project_id
string
required

ID of the project this property is scoped to

​
name
string
required

User-provided dataset name, e.g. 'Electrolyte transport'

​
columns
ColumnSpec · object[]
required

All columns in the dataset with their units.

​
id
string
required

Unique identifier

​
organization_id
string
required

Organization that owns this record

​
storage_path
string
required

Path to the processed parquet file in the material-property-datasets bucket.

​
data_version
integer
required

Increments on every data-changing operation (file replacement or column re-processing). Downstream code can store this alongside computed results and compare against the current value to detect staleness.

​
created_at
string<date-time>
required

Upload timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
original_path
string | null

Path to the raw original file in the material-property-datasets bucket. NULL only for records created before this field was introduced.

​
nan_counts
Nan Counts · object

Number of NaN/null values per column, keyed by display name. Computed at upload time. None for records uploaded before this field was introduced.

​
no_header
boolean
default:false

True when the uploaded CSV had no header row. Column positions are mapped via source_column_index on each column spec.

​
created_by
string | null

User ID of the uploader