Skip to content

Model predictions

List model estimates

curl https://app.rejoule.io/models/predictions/ \
    -H "Authorization: User <token>"

The following query parameters are available:

Name Type Description
limit integer Number of results to return per page.
offset integer The initial index from which to return the results.
id string id
organization string organization
battery_model string battery_model
test string test
project string project
created string created
updated string updated

Create a model estimate

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/models/predictions/ \
    -X POST \
    -H "Authorization: User <token>" \
    -F "organization=12" \
    -F "battery_model_version=12" \
    -F "test=20"

Get a single model estimate

curl https://app.rejoule.io/models/predictions/{id}/ \
    -H "Authorization: User <token>"

The response object contains the following fields:

Name Type Description
id integer
organization integer
battery_model_version integer The battery model version used to produce this estimate.
test integer The test providing input data for this estimate.
capacity_prediction number The estimated capacity produced by the model.
soh_prediction number The estimated state of health produced by the model.
grading_prediction string The estimated grade produced by the model.
confidence_score number The confidence level for the estimate produced by the model.
capacity_std number The standard deviation for the capacity estiamte produced by the model.
soh_std number The standard deviation for the state of health estiamte produced by the model.
projects array
notes string
created_at string
updated_at string
created_by string

Update a model estimate

Member Role required

Editing requires an Member role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/models/predictions/{id}/ \
    -X PUT \
    -H "Authorization: User <token>" \
    -F "organization=7" \
    -F "battery_model_version=15" \
    -F "test=18"

Delete a model estimate

Owner Role required

Deleting requires an Owner role in the organization the resource belongs to. Find out more.

curl https://app.rejoule.io/models/predictions/{id}/ \
    -X DELETE \
    -H "Authorization: User <token>"