Core Platform
Generate model-sampled financial stress scenarios from an approved VAE
POST
/ml/scenarios
Overview
Quickstart
API reference
Guides
LQM Builder
SDKs
Auth & webhooks
Changes
Versioning
CI
Support
Certification
Programme
Ecosystem
Solutions
References
Evidence exchange
Status
Marketplace
API plans
Contract
Authentication
Bearer credential required
Required scope
ml:inference
Status
Published
Request body
application/json
ยท
optional
{
"samples": 5,
"stress": []
}
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 '{
"samples": 5,
"stress": []
}' \
"https://financegpt.dev/api/v2/ml/scenarios"
javascript
const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/ml\/scenarios", {
method: "POST",
headers: {
Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"samples": 5,
"stress": []
}),
});
const data = await response.json();
python
import json
import os
import requests
response = requests.request(
'POST',
'https://financegpt.dev/api/v2/ml/scenarios',
headers={
'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
'Accept': 'application/json',
},
json=json.loads('{"samples":5,"stress":[]}'),
)
response.raise_for_status()
print(response.json())
php
<?php
$ch = curl_init('https://financegpt.dev/api/v2/ml/scenarios');
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 (
'samples' => 5,
'stress' =>
array (
),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Responses
| Status | Description |
|---|---|
201 |
Generated scenario samples; not forecasts or probabilities |
409 |
Approved model or synchronized features unavailable |
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.
ml:inference