Models

Activate a model version

Marks the given model version as active. The previously active sibling version (same name, same project) is automatically deactivated. Activation is the equivalent of pinning the version as the default used for new batch generations and model runs; per-batch overrides can still target other versions via model_overrides on POST /ledgers/{ledger_id}/batch_generations. Any version can be activated, not only the latest. Activation requires explicit confirmation: pass confirm: true to guard against accidental promotion. Requires the write:model token scope.

POST

models

{model_id}

activate

Activate a model version

curl --request POST \
  --url https://app.gomangrove.com/api/v1/models/{model_id}/activate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "confirm": true
}
'

import requests

url = "https://app.gomangrove.com/api/v1/models/{model_id}/activate"

payload = { "confirm": True }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({confirm: true})
};

fetch('https://app.gomangrove.com/api/v1/models/{model_id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/models/{model_id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'confirm' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/models/{model_id}/activate"

	payload := strings.NewReader("{\n  \"confirm\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gomangrove.com/api/v1/models/{model_id}/activate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirm\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/models/{model_id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"confirm\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "mod_aBcD1234eFgH5678",
  "name": "Carbon Calculation Model",
  "version": 1,
  "version_label": null,
  "description": null,
  "is_active": true,
  "cadence": "monthly",
  "partition_type": "feedstock",
  "order": 1,
  "is_latest": false,
  "is_score_producing": false,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-16T10:00:00.000Z",
  "ledger": null,
  "quantification_methodology": null,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/system/mod_aBcD1234eFgH5678"
}

Authorizations

Authorization

string

header

required

Path Parameters

model_id

string

required

The model's friendly ID (e.g. mod_aBcD1234eFgH5678).

Body

application/json

confirm

boolean

required

Must be true. Guards against accidental activation.

Response

200

One version of a model. Every endpoint that returns a model returns this shape.

string

The model's friendly ID (e.g. mod_aBcD1234eFgH5678). Each version has its own.

Example:

"mod_aBcD1234eFgH5678"

name

string

Shared by every version of the model.

version

integer

Version number. A model created through the API starts at 0, and each new version adds one.

version_label

string | null

A short name for the version, up to 255 characters (letters, numbers, spaces and _ - . ( ) /).

description

string | null

What changed in the version, up to 500 characters.

is_active

boolean

Whether this is the version new batch generations and model runs use by default. At most one version of a model is active; the first version is active when it is created.

cadence

enum<string> | null

Available options:

hourly,

daily,

weekly,

monthly,

annually,

null

partition_type

enum<string> | null

How batches are partitioned. The composite values partition by both dimensions at once.

Available options:

time,

feedstock,

tracking_id,

asset,

tracking_id_and_feedstock,

tracking_id_and_asset,

null

order

integer

is_latest

boolean

Whether this is the highest version number of the model.

is_score_producing

boolean

Whether the model produces carbon intensity score sets rather than batches.

created_at

string<date-time>

updated_at

string<date-time>

ledger

object | null

The production accounting ledger the model produces batches into, or null when it is not linked to one.

Show child attributes

quantification_methodology

object | null

The designated quantification methodology, or null for a production model.

Show child attributes

ui_url

string<uri> | null

Link that opens this model in the Mangrove app. Null when the model has no project.

Example:

"https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/system/mod_aBcD1234eFgH5678"

Activate a model version

curl --request POST \
  --url https://app.gomangrove.com/api/v1/models/{model_id}/activate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "confirm": true
}
'

import requests

url = "https://app.gomangrove.com/api/v1/models/{model_id}/activate"

payload = { "confirm": True }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({confirm: true})
};

fetch('https://app.gomangrove.com/api/v1/models/{model_id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/models/{model_id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'confirm' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/models/{model_id}/activate"

	payload := strings.NewReader("{\n  \"confirm\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gomangrove.com/api/v1/models/{model_id}/activate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirm\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/models/{model_id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"confirm\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "mod_aBcD1234eFgH5678",
  "name": "Carbon Calculation Model",
  "version": 1,
  "version_label": null,
  "description": null,
  "is_active": true,
  "cadence": "monthly",
  "partition_type": "feedstock",
  "order": 1,
  "is_latest": false,
  "is_score_producing": false,
  "created_at": "2025-01-15T10:00:00.000Z",
  "updated_at": "2025-01-16T10:00:00.000Z",
  "ledger": null,
  "quantification_methodology": null,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/system/mod_aBcD1234eFgH5678"
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Activate a model version

Authorizations

Path Parameters

Body

Response