Skip to main content
POST
/
models
/
{model_id}
/
model_runs
Create a model run
curl --request POST \
  --url https://app.gomangrove.com/api/v1/models/{model_id}/model_runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model_run": {
    "start_time": "2025-01-01T00:00:00Z",
    "end_time": "2025-03-31T23:59:59Z",
    "data_point_ids": [
      "dp_abc123",
      "dp_def456"
    ]
  }
}
'
{
  "id": 1,
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z",
  "state": "complete",
  "error_message": null,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-15T10:00:00.000Z",
  "calculations": [
    {
      "id": 1,
      "name": "Net Carbon Removal",
      "value": 100.5,
      "unit": "t",
      "ghg": "co2e",
      "lca_role": "net",
      "category": "removal"
    }
  ],
  "output_data_points": [
    {
      "id": "dp_abc123",
      "slug": "net-carbon-removal",
      "data_point_type": "Net Carbon Removal",
      "value": 100.5,
      "unit": "t",
      "status": "complete"
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

model_id
string
required

Model friendly ID (e.g., mdl_abc123def456)

Body

application/json
model_run
object
required

Response

201

id
integer
start_time
string<date-time>
end_time
string<date-time>
state
string
error_message
string | null
created_at
string<date-time>
updated_at
string<date-time>
calculations
object[]
output_data_points
object[]