Skip to main content
Quant & Models

Generate reproducible multi-period synthetic financial stress paths

POST /generative/paths

Contract

Authentication
Bearer credential required
Required scope
generative:inference
Status
Published

Request body

application/json ยท required
{
    "regime": "contraction",
    "samples": 3,
    "horizon": 6,
    "seed": 42,
    "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 '{
    "regime": "contraction",
    "samples": 3,
    "horizon": 6,
    "seed": 42,
    "stress": []
}' \
  "https://financegpt.dev/api/v2/generative/paths"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/generative\/paths", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "regime": "contraction",
    "samples": 3,
    "horizon": 6,
    "seed": 42,
    "stress": []
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/generative/paths',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"regime":"contraction","samples":3,"horizon":6,"seed":42,"stress":[]}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/generative/paths');
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 (
  'regime' => 'contraction',
  'samples' => 3,
  'horizon' => 6,
  'seed' => 42,
  'stress' => 
  array (
  ),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Seeded multi-period path run with model/version/source hashes
409 Approved time-series model or synchronized feature context 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.

generative:inference

Machine-readable sources