Skip to main content
POST
/
models
/
{model_id}
/
yaml_validate
Validate model YAML
curl --request POST \
  --url https://app.gomangrove.com/api/v1/models/{model_id}/yaml_validate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "yaml": "nexus:\n  - name: Net Carbon Removal\n    formula: input_1 - input_2\n"
}
'
import requests

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

payload = { "yaml": "nexus:
  - name: Net Carbon Removal
    formula: input_1 - input_2
" }
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({yaml: 'nexus:\n  - name: Net Carbon Removal\n    formula: input_1 - input_2\n'})
};

fetch('https://app.gomangrove.com/api/v1/models/{model_id}/yaml_validate', 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}/yaml_validate",
  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([
    'yaml' => 'nexus:
  - name: Net Carbon Removal
    formula: input_1 - input_2
'
  ]),
  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}/yaml_validate"

	payload := strings.NewReader("{\n  \"yaml\": \"nexus:\\n  - name: Net Carbon Removal\\n    formula: input_1 - input_2\\n\"\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}/yaml_validate")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"yaml\": \"nexus:\\n  - name: Net Carbon Removal\\n    formula: input_1 - input_2\\n\"\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"yaml\": \"nexus:\\n  - name: Net Carbon Removal\\n    formula: input_1 - input_2\\n\"\n}"

response = http.request(request)
puts response.read_body
{ "valid": true, "errors": [], "warnings": [] }

Authorizations

Authorization
string
header
required

Path Parameters

model_id
string
required

Model friendly ID (e.g., mdl_abc123def456)

Body

application/json
yaml
string
required

YAML content to validate

Response

200 - application/json

200

valid
boolean
errors
object[]
warnings
object[]