Skip to main content
POST
/
models
/
{model_id}
/
simulate
Simulate a model
curl --request POST \
  --url https://app.gomangrove.com/api/v1/models/{model_id}/simulate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "feedstock-volume": 1000,
    "carbon-content": 0.45
  },
  "start_time": "2025-01-01T00:00:00Z",
  "end_time": "2025-03-31T23:59:59Z"
}
'
{
  "results": {
    "net-carbon-removal": 450.5,
    "emissions": 12.3
  },
  "errors": [],
  "execution_time_ms": 45.2
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
model_id
string
required

Model friendly ID (e.g., mdl_abc123def456)

Body

application/json
​
inputs
object
required

Input values keyed by data point type slug

​
start_time
string<date-time>
required

ISO 8601 date/datetime for simulation period start

​
end_time
string<date-time>
required

ISO 8601 date/datetime for simulation period end

Response

200 - application/json

200

​
results
object
​
errors
string[]
​
execution_time_ms
number