Reject a suggestion

curl --request POST \
  --url https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "reason": "Carrier delays are refunded through the carrier's claim, not by us."
}
EOF

import requests

url = "https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject"

payload = { "reason": "Carrier delays are refunded through the carrier's claim, not by us." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Carrier delays are refunded through the carrier\'s claim, not by us.'})
};

fetch('https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject', 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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject",
  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([
    'reason' => 'Carrier delays are refunded through the carrier\'s claim, not by us.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject"

	payload := strings.NewReader("{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}"

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

{
  "id": "sug_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e70",
  "decision_id": "refund-exception",
  "kind": "new_question",
  "target": "structure",
  "summary": "Ask whether the parcel arrived late or got lost, and count it toward granting",
  "environment": "test",
  "base": {
    "version": {
      "structure_hash": "sha256:bdad6e5b1b879209305f1555b43ec62666a4d74a925280c66e54cc4dc07bb1ae",
      "number": 1
    },
    "model": {
      "profile": "defective=jev:jev-1.14.0@jev@0.1.0,item_used=jev:jev-1.14.0@jev@0.1.0"
    }
  },
  "candidate": {
    "version": {
      "structure_hash": "sha256:8b4e793adb3c0d8dbf8b57fd9fe3450789681a5d0a727e0e2013514fc210506d",
      "number": null
    },
    "model": {
      "profile": "defective=jev:jev-1.14.0@jev@0.1.0,item_used=jev:jev-1.14.0@jev@0.1.0,shipping_failure=jev:jev-1.14.0@jev@0.1.0"
    }
  },
  "requires": [],
  "candidate_structure": {
    "questions": {
      "item_used": {
        "type": "noul",
        "instructions": "Has the customer used the item beyond trying it on or setting it up once?",
        "reads": [
          "state.message"
        ]
      },
      "defective": {
        "type": "noul",
        "instructions": "Does the customer describe a defect, damage on arrival, or the item failing under normal use?",
        "reads": [
          "state.message"
        ]
      },
      "shipping_failure": {
        "type": "noul",
        "instructions": "Did the order arrive later than promised, or get lost in transit?",
        "reads": [
          "state.message"
        ]
      }
    },
    "attributes": {
      "days_since_delivery": {
        "type": "number",
        "minimum": 0
      }
    },
    "aggregations": {
      "grant_score": {
        "type": "weighted_mean",
        "inputs": [
          {
            "name": "questions.item_used",
            "invert": true
          },
          {
            "name": "questions.defective"
          },
          {
            "name": "questions.shipping_failure"
          }
        ]
      },
      "handling": {
        "type": "rules",
        "rules": [
          {
            "when": {
              "name": "attributes.days_since_delivery",
              "gt": 30
            },
            "outcome": "escalate"
          },
          {
            "when": {
              "name": "aggregations.grant_score",
              "gte": 0.72
            },
            "outcome": "grant"
          },
          {
            "when": {
              "name": "aggregations.grant_score",
              "lt": 0.38
            },
            "outcome": "deny"
          }
        ],
        "else": "escalate"
      }
    },
    "result": "aggregations.handling"
  },
  "diff": [
    {
      "op": "add",
      "path": "/questions/shipping_failure",
      "after": {
        "type": "noul",
        "instructions": "Did the order arrive later than promised, or get lost in transit?",
        "reads": [
          "state.message"
        ]
      }
    },
    {
      "op": "add",
      "path": "/aggregations/grant_score/inputs/-",
      "after": {
        "name": "questions.shipping_failure"
      }
    }
  ],
  "evidence": {
    "label": "training_cases",
    "frozen_at": "2026-11-06T16:00:00.000Z",
    "by_split": {
      "train": {
        "n": 5,
        "fixes": 2,
        "breaks": 0,
        "base_correct": 3,
        "candidate_correct": 5
      }
    },
    "noise_rate": 0,
    "action_mix": null,
    "changed_items": [
      {
        "evaluation_id": "evl_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e41",
        "feedback_id": "fbk_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e50",
        "split": "train",
        "change": "fix",
        "before": {
          "outcome": "escalate",
          "answers": {
            "item_used": 0.02,
            "defective": 0.3
          }
        },
        "after": {
          "outcome": "grant",
          "answers": {
            "item_used": 0.02,
            "defective": 0.3,
            "shipping_failure": 0.97
          }
        }
      },
      {
        "evaluation_id": "evl_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e42",
        "feedback_id": "fbk_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e51",
        "split": "train",
        "change": "fix",
        "before": {
          "outcome": "escalate",
          "answers": {
            "item_used": 0,
            "defective": 0.2
          }
        },
        "after": {
          "outcome": "grant",
          "answers": {
            "item_used": 0,
            "defective": 0.2,
            "shipping_failure": 0.99
          }
        }
      }
    ],
    "credited_feedback": []
  },
  "preview_id": "prv_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e71",
  "objective": {
    "revision": 1,
    "objective_hash": "sha256:17c4fed8a47b7094ae83485aab46436ced0b00f24be5b059f2bf6984a4e4e4b3"
  },
  "generator": {
    "name": "anthropic",
    "version": "3",
    "model": "claude-sonnet"
  },
  "status": "rejected",
  "created_at": "2026-11-06T16:00:00.000Z",
  "status_at": "2026-11-06T17:00:00.000Z",
  "rejection_reason": "Carrier delays are refunded through the carrier's claim, not by us."
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

POST

suggestions

{suggestion_id}

reject

Reject a suggestion

curl --request POST \
  --url https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "reason": "Carrier delays are refunded through the carrier's claim, not by us."
}
EOF

import requests

url = "https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject"

payload = { "reason": "Carrier delays are refunded through the carrier's claim, not by us." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Carrier delays are refunded through the carrier\'s claim, not by us.'})
};

fetch('https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject', 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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject",
  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([
    'reason' => 'Carrier delays are refunded through the carrier\'s claim, not by us.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject"

	payload := strings.NewReader("{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.moonbounce.ai/v1/suggestions/{suggestion_id}/reject")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Carrier delays are refunded through the carrier's claim, not by us.\"\n}"

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

{
  "id": "sug_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e70",
  "decision_id": "refund-exception",
  "kind": "new_question",
  "target": "structure",
  "summary": "Ask whether the parcel arrived late or got lost, and count it toward granting",
  "environment": "test",
  "base": {
    "version": {
      "structure_hash": "sha256:bdad6e5b1b879209305f1555b43ec62666a4d74a925280c66e54cc4dc07bb1ae",
      "number": 1
    },
    "model": {
      "profile": "defective=jev:jev-1.14.0@jev@0.1.0,item_used=jev:jev-1.14.0@jev@0.1.0"
    }
  },
  "candidate": {
    "version": {
      "structure_hash": "sha256:8b4e793adb3c0d8dbf8b57fd9fe3450789681a5d0a727e0e2013514fc210506d",
      "number": null
    },
    "model": {
      "profile": "defective=jev:jev-1.14.0@jev@0.1.0,item_used=jev:jev-1.14.0@jev@0.1.0,shipping_failure=jev:jev-1.14.0@jev@0.1.0"
    }
  },
  "requires": [],
  "candidate_structure": {
    "questions": {
      "item_used": {
        "type": "noul",
        "instructions": "Has the customer used the item beyond trying it on or setting it up once?",
        "reads": [
          "state.message"
        ]
      },
      "defective": {
        "type": "noul",
        "instructions": "Does the customer describe a defect, damage on arrival, or the item failing under normal use?",
        "reads": [
          "state.message"
        ]
      },
      "shipping_failure": {
        "type": "noul",
        "instructions": "Did the order arrive later than promised, or get lost in transit?",
        "reads": [
          "state.message"
        ]
      }
    },
    "attributes": {
      "days_since_delivery": {
        "type": "number",
        "minimum": 0
      }
    },
    "aggregations": {
      "grant_score": {
        "type": "weighted_mean",
        "inputs": [
          {
            "name": "questions.item_used",
            "invert": true
          },
          {
            "name": "questions.defective"
          },
          {
            "name": "questions.shipping_failure"
          }
        ]
      },
      "handling": {
        "type": "rules",
        "rules": [
          {
            "when": {
              "name": "attributes.days_since_delivery",
              "gt": 30
            },
            "outcome": "escalate"
          },
          {
            "when": {
              "name": "aggregations.grant_score",
              "gte": 0.72
            },
            "outcome": "grant"
          },
          {
            "when": {
              "name": "aggregations.grant_score",
              "lt": 0.38
            },
            "outcome": "deny"
          }
        ],
        "else": "escalate"
      }
    },
    "result": "aggregations.handling"
  },
  "diff": [
    {
      "op": "add",
      "path": "/questions/shipping_failure",
      "after": {
        "type": "noul",
        "instructions": "Did the order arrive later than promised, or get lost in transit?",
        "reads": [
          "state.message"
        ]
      }
    },
    {
      "op": "add",
      "path": "/aggregations/grant_score/inputs/-",
      "after": {
        "name": "questions.shipping_failure"
      }
    }
  ],
  "evidence": {
    "label": "training_cases",
    "frozen_at": "2026-11-06T16:00:00.000Z",
    "by_split": {
      "train": {
        "n": 5,
        "fixes": 2,
        "breaks": 0,
        "base_correct": 3,
        "candidate_correct": 5
      }
    },
    "noise_rate": 0,
    "action_mix": null,
    "changed_items": [
      {
        "evaluation_id": "evl_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e41",
        "feedback_id": "fbk_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e50",
        "split": "train",
        "change": "fix",
        "before": {
          "outcome": "escalate",
          "answers": {
            "item_used": 0.02,
            "defective": 0.3
          }
        },
        "after": {
          "outcome": "grant",
          "answers": {
            "item_used": 0.02,
            "defective": 0.3,
            "shipping_failure": 0.97
          }
        }
      },
      {
        "evaluation_id": "evl_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e42",
        "feedback_id": "fbk_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e51",
        "split": "train",
        "change": "fix",
        "before": {
          "outcome": "escalate",
          "answers": {
            "item_used": 0,
            "defective": 0.2
          }
        },
        "after": {
          "outcome": "grant",
          "answers": {
            "item_used": 0,
            "defective": 0.2,
            "shipping_failure": 0.99
          }
        }
      }
    ],
    "credited_feedback": []
  },
  "preview_id": "prv_0199f2c4-1a2b-7c3d-8e4f-5a6b7c8d9e71",
  "objective": {
    "revision": 1,
    "objective_hash": "sha256:17c4fed8a47b7094ae83485aab46436ced0b00f24be5b059f2bf6984a4e4e4b3"
  },
  "generator": {
    "name": "anthropic",
    "version": "3",
    "model": "claude-sonnet"
  },
  "status": "rejected",
  "created_at": "2026-11-06T16:00:00.000Z",
  "status_at": "2026-11-06T17:00:00.000Z",
  "rejection_reason": "Carrier delays are refunded through the carrier's claim, not by us."
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "<string>",
    "reason": "<string>",
    "param": "<string>",
    "details": {
      "issues": [
        {
          "param": "<string>",
          "code": "<string>",
          "message": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

An API key, sent as Authorization: Bearer <key>. Each operation lists the scope its key needs: decisions:evaluate (evaluate and read evaluations), decisions:feedback (your app's feedback) or decisions:develop (everything else, including owner feedback and the review queue). An operation listing no scope takes any scoped key. A key with no scope, or without the operation's, gets 403 INSUFFICIENT_SCOPE.

Headers

idempotency-key

string

Makes a retry safe. For 24 hours, the same key with the same request returns the first stored result (with Idempotent-Replayed: true); the same key with a different request is a 422 IDEMPOTENCY_KEY_REUSED. Keys are scoped to the organization and environment across every operation, so use a fresh key per request. A request that failed before its result was stored runs again when retried with its key.

Required string length: 1 - 255

Pattern: ^[\x20-\x7e]+$

Path Parameters

suggestion_id

string

required

Pattern: ^sug_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

reason

string

Why you won't apply it, kept with the suggestion as rejection_reason.

Required string length: 1 - 2000

Response

The rejected suggestion

string

required

Pattern: ^sug_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

decision_id

string

required

A name you choose for this decision, such as refund-exception: a lowercase letter, then up to 127 of a-z 0-9 _ . -. Unique in your organization and shared by its test and production keys. The first registration or evaluation under a new one creates the decision.

Pattern: ^[a-z][a-z0-9_.-]{0,127}$

kind

enum<string>

required

question_rewrite: new wording for one question (its question text and criteria). new_question: one new question, added as an input of the aggregation that feeds the result's bands or rules.

Available options:

question_rewrite,

new_question

target

enum<string>

required

Available options:

structure

summary

string

required

environment

enum<string>

required

The environment of the key that made the call: production or test. Evaluations, feedback, reviews and suggestions are separate per environment; decisions and their versions belong to the whole organization.

Available options:

production,

test

base

object

required

Show child attributes

candidate

object

required

Show child attributes

requires

string[]

required

Pattern: ^sug_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

candidate_structure

object

required

Everything that defines a decision: questions, attribute declarations, aggregations and the result. Names are unique across all three maps.

Show child attributes

diff

object[]

required

Show child attributes

evidence

object

required

Show child attributes

preview_id

string

required

The preview that is this suggestion's evidence: prv_, or run_ for one stored before prv_.

Pattern: ^(prv|run)_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

generator

object

required

Show child attributes

status

enum<string>

required

Available options:

proposed,

pulled,

accepted,

rejected,

superseded

created_at

string<date-time>

required

objective

object | null

The stored objective revision its preview was scored with, or null when none was set (balanced losses). Absent on suggestions made before previews were judged, when none was set.

Show child attributes

status_at

string<date-time>

rejection_reason

string

accepted_evaluation_id

string

Pattern: ^evl_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

accepted_at

string<date-time>

stale

object

Present when feedback on cases this suggestion was evaluated on changed after its evidence was read: an answer it read was changed, withdrawn or corrected, or the owner, a reviewer or an imported example judged one of its cases since, or any feedback since marked one's input as broken. Its evidence is as it was then; preview it again before relying on it.

Show child attributes

Overview

Evaluate

Decisions

Feedback

Suggestions

Previews & tests

Models

Objective

Usage

Account

Reject a suggestion

Authorizations

Headers

Path Parameters

Body

Response