Skip to main content
LQM Builder

Retire an active LQM Quant Models promotion

POST /lqm/promotions/{promotionUid}/retire

Contract

Human retirement disables the promoted Quant Models version. Existing QLM versions remain immutable and fail closed rather than silently rebinding to another checkpoint.

Authentication
Bearer credential required
Required scope
lqm:promote:write
Status
Published

Parameters

Name Location Type Required Description
promotionUid path string Yes

Request body

application/json · optional
{
    "decision_note": "string"
}

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "decision_note": "string"
}' \
  "https://financegpt.dev/api/v2/lqm/promotions/{promotionUid}/retire"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/lqm\/promotions\/{promotionUid}\/retire", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "decision_note": "string"
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/lqm/promotions/{promotionUid}/retire',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"decision_note":"string"}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/lqm/promotions/{promotionUid}/retire');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(array (
  'decision_note' => 'string',
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
200 Promotion retired
409 Promotion is not active or cannot be retired

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

lqm:promote:write

Machine-readable sources