API Reference
Get a model’s schema including required inputs, outputs, and available operators. Useful for discovering what inputs a simulation needs.
cURL
curl --request GET \ --url https://app.gomangrove.com/api/v1/models/{model_id}/schema \ --header 'Authorization: <api-key>'
{ "model": { "id": "mdl_abc123def456", "name": "Carbon Calculation Model", "version": 1 }, "required_inputs": [ { "slug": "feedstock-volume", "name": "Feedstock Volume", "type": "numeric", "unit": "kg", "description": "Volume of feedstock processed" } ], "outputs": [ { "id": 1, "name": "Net Carbon Removal", "unit": "t", "ghg": "co2e", "lca_role": "net" } ], "operators": [ "add", "subtract", "multiply", "divide" ], "example_simulation": { "inputs": { "feedstock-volume": 1000 }, "start_time": "2025-01-01T00:00:00Z", "end_time": "2025-03-31T23:59:59Z" } }
Model friendly ID (e.g., mdl_abc123def456)
200
Show child attributes