Install Workflow Recipe

Install a governed workflow recipe into the authenticated workspace as an M6 workflow template.

Version: v2

Stability: stable

Sandbox: Available

Production: Entitlement required

Target latency: ≤ 450 ms

POST/api/v2/workflows/library/{key}/install

Installing a recipe creates a governed workflow template only; it does not move money or execute trades.

Required scope: workflow:manage

Try it in the FinanceGPT sandbox

The playground uses deterministic isolated sandbox fixtures. It never queries production workspace data and does not require you to paste an API secret into the browser.

Example response

{
    "data": {
        "status": "installed",
        "financial_action_executed": false
    }
}

Code examples

curl

curl -X POST \
  https://equitygpt.app/api/v2/workflows/library/13-week-cash-forecast/install \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cadence":"weekly"}'

python

import os, requests

url = "https://equitygpt.app/api/v2/workflows/library/13-week-cash-forecast/install"
headers = {"Authorization": f"Bearer {os.environ['FINANCEGPT_API_KEY']}"}
payload = {
    "cadence": "weekly"
}
response = requests.request("POST", url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

javascript

const response = await fetch('https://equitygpt.app/api/v2/workflows/library/13-week-cash-forecast/install', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.FINANCEGPT_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({"cadence":"weekly"})
});
if (!response.ok) throw new Error(`FinanceGPT ${response.status}`);
console.log(await response.json());

php

<?php
$ch = curl_init('https://equitygpt.app/api/v2/workflows/library/13-week-cash-forecast/install');
curl_setopt_array($ch, [CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => ['Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => '{\"cadence\":\"weekly\"}']);
$response = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) >= 400) throw new RuntimeException($response);
echo $response;

Versions & changelog

v2 published

M28 publication of this governed FinanceGPT API operation.

Ready to build?

Explorer gives immediate isolated sandbox access. Production plans require a commercial entitlement.

Create account