FinanceGPT Developer Platform
API Reference
Search the complete API v2 contract by capability, method, path or least-privilege scope. Every result is generated from the published OpenAPI contract.
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
Operations
349
Published API operations
Paths
329
OpenAPI paths
Scopes
66
Explicit authority boundaries
Matches
349
Current filters
Operations
Reference pages include parameters, request shape, responses and copy-ready snippets without sending a request from the public documentation surface.
| Method | Path | Summary | Scope | Group | |
|---|---|---|---|---|---|
| POST | /agent-execution/a2a | Invoke the signed FinanceGPT agent-to-agent execution gateway | agent:execution:invoke | Agents & MCP | Open |
| GET | /agent-execution/actions/{uid} | Read governed Financial Action status | agent:execution:read | Agents & MCP | Open |
| GET | /agent-execution/actions/{uid}/assurance | Read Financial Actions assurance evidence | agent:execution:read | Agents & MCP | Open |
| POST | /agent-execution/actions/{uid}/execute | Request execution of an already-authorized Financial Action | agent:execution:execute | Agents & MCP | Open |
| GET | /agent-execution/actions/{uid}/reconciliation | Read Financial Action reconciliation evidence | agent:execution:read | Agents & MCP | Open |
| POST | /agent-execution/actions/{uid}/submit | Submit an external-agent Financial Action for approval | agent:execution:submit | Agents & MCP | Open |
| GET | /agent-execution/capabilities | Read signed external-agent execution capabilities | agent:execution:read | Agents & MCP | Open |
| POST | /agent-execution/mcp | Invoke the signed FinanceGPT Financial Actions MCP execution gateway | agent:execution:invoke | Agents & MCP | Open |
| POST | /agent-execution/proposals | Propose a governed Financial Action from an external agent | agent:execution:propose | Agents & MCP | Open |
| GET | /agent-execution/requests/{uid} | Read agent-execution request evidence | agent:execution:read | Agents & MCP | Open |
| GET | /agent-execution/service-level | Read active agent-execution service level | agent:execution:read | Agents & MCP | Open |
| GET | /agent-execution/usage | Read external-agent execution usage evidence | agent:execution:read | Agents & MCP | Open |
| GET | /agent-execution/webhooks | List signed Financial Action and workflow lifecycle webhooks | agent:execution:webhooks | Agents & MCP | Open |
| POST | /agent-execution/webhooks | Register a signed HTTPS Financial Action or workflow lifecycle webhook | agent:execution:webhooks | Agents & MCP | Open |
| DELETE | /agent-execution/webhooks/{uid} | Revoke an agent-execution lifecycle webhook | agent:execution:webhooks | Agents & MCP | Open |
| GET | /agents/executions/{uid} | Read one queued Agent Space execution | agents:spaces:read | Agents & MCP | Open |
| GET | /agents/invocations | List hash-only MCP invocation audit metadata for this agent credential | agents:mcp:read | Agents & MCP | Open |
| GET | /agents/runs/{runUid} | Read one governed FinanceGPT Agent Space run | agents:spaces:read | Agents & MCP | Open |
| GET | /agents/spaces | List production FinanceGPT Agent Spaces for the active workspace | agents:spaces:read | Agents & MCP | Open |
| GET | /agents/spaces/{uid} | Read one production FinanceGPT Agent Space and its governed bindings | agents:spaces:read | Agents & MCP | Open |
| POST | /agents/spaces/{uid}/runs | Run a promoted FinanceGPT Agent Space | agents:spaces:run | Agents & MCP | Open |
| GET | /agents/tools | List FinanceGPT MCP tools and credential grant state | agents:mcp:read | Agents & MCP | Open |
| GET | /ai-credits/balance | Read the active workspace FinanceGPT AI Credit balance and subscription allocation | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/controls | Read workspace and caller FinanceGPT AI Credit spending controls | ai:credits:read | AI Runtime & Governance | Open |
| POST | /ai-credits/estimate | Estimate the FinanceGPT AI Credit reservation for a Managed AI request without executing it | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/packs | List active FinanceGPT AI Credit packs available to the active workspace | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/purchases | Read verified FinanceGPT AI Credit purchase history for the active workspace | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/rates | Read active FinanceGPT Managed AI Credit rate cards | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/transactions | Read the active workspace immutable FinanceGPT AI Credit ledger | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai-credits/usage | Read FinanceGPT Managed AI usage, forecast and utilization for the active workspace | ai:credits:read | AI Runtime & Governance | Open |
| GET | /ai/byok/connections | Read customer-managed AI provider connection status for the active workspace | ai:connections:read | AI Runtime & Governance | Open |
| GET | /ai/byok/usage | Read customer-managed AI provider usage for the active workspace | ai:connections:read | AI Runtime & Governance | Open |
| GET | /ai/evaluations | Read recent governed AI ground-truth evaluation runs | ai:governance:read | AI Runtime & Governance | Open |
| POST | /ai/feedback | Submit a quality signal for an existing FinanceGPT generated output | ai:governance:write | AI Runtime & Governance | Open |
| GET | /ai/governance | Read AI quality and governance posture for the active workspace | ai:governance:read | AI Runtime & Governance | Open |
| GET | /ai/model-selections | Read Universal Model Switching choices for the active workspace | ai:models:read | AI Runtime & Governance | Open |
| GET | /ai/models | Read the FinanceGPT Managed AI model catalogue | ai:models:read | AI Runtime & Governance | Open |
| GET | /ai/routing | Read the active workspace Hybrid AI routing policy and explicit rules | ai:routing:read | AI Runtime & Governance | Open |
| POST | /ai/routing/resolve | Simulate a Hybrid AI routing decision without executing model inference | ai:routing:read | AI Runtime & Governance | Open |
| GET | /ai/runtime | Read the active workspace Managed AI runtime posture | ai:models:read | AI Runtime & Governance | Open |
| GET | /benchmarking/comparisons | List published privacy-safe benchmark comparisons | benchmark:read | Core Platform | Open |
| GET | /client-intelligence/calls | Read governed Client Intelligence conversation records | client:intelligence:read | Core Platform | Open |
| GET | /client-intelligence/calls/{uid} | Read one Client Intelligence conversation with transcript and review evidence | client:intelligence:read | Core Platform | Open |
| POST | /client-intelligence/calls/{uid}/analyse | Run governed FinanceGPT post-call analysis through Hybrid AI routing | client:intelligence:run | Core Platform | Open |
| POST | /client-intelligence/calls/{uid}/transcript | Add a governed transcript version to a Client Intelligence conversation | client:intelligence:write | Core Platform | Open |
| GET | /infrastructure/data-entitlements | Read workspace contractual data-entitlement overlays | infrastructure:read | Core Platform | Open |
| POST | /infrastructure/lineage-exports | Create a sealed FinanceGPT lineage manifest | infrastructure:lineage | Core Platform | Open |
| GET | /infrastructure/lineage-exports/{uid} | Retrieve a sealed lineage manifest | infrastructure:lineage | Core Platform | Open |
| GET | /infrastructure/posture | Read workspace institutional compute and licensing posture | infrastructure:read | Core Platform | Open |
| GET | /infrastructure/regions | List configured compute regions and explicit deployment state | infrastructure:read | Core Platform | Open |
| GET | /infrastructure/service-classes | List FinanceGPT compute service classes | infrastructure:read | Core Platform | Open |
| GET | /infrastructure/usage | Read 30-day institutional compute telemetry | infrastructure:read | Core Platform | Open |
| GET | /integrations | Read workspace Integration Hub connections and secret-free tool definitions | integrations:read | Core Platform | Open |
| GET | /intelligence/summary | Retrieve an embedded cross-domain FinanceGPT intelligence summary | intelligence:read | Core Platform | Open |
| GET | /investment/book | Read the workspace investment book control surface | investment:read | Core Platform | Open |
| GET | /investment/collateral-xva | Read collateral, margin, treasury and XVA operating evidence | investment:read | Core Platform | Open |
| POST | /investment/collateral-xva/exposures/{exposure}/xva | Calculate deterministic CVA/DVA/FVA/MVA foundations | investment:run | Core Platform | Open |
| POST | /investment/collateral-xva/netting-sets | Record an evidence-backed netting set | investment:run | Core Platform | Open |
| POST | /investment/collateral-xva/netting-sets/{nettingSet}/exposure | Seal explicit counterparty/netting-set exposure evidence | investment:run | Core Platform | Open |
| POST | /investment/collateral-xva/netting-sets/{nettingSet}/margin-calls | Record a margin-call evidence item | investment:run | Core Platform | Open |
| POST | /investment/collateral-xva/rules | Record a collateral eligibility and haircut rule | investment:run | Core Platform | Open |
| GET | /investment/companies/{symbol} | Read governed Company 360 investment evidence | investment:read | Core Platform | Open |
| GET | /investment/construction/runs | Read governed Portfolio Construction 2.0 runs | investment:read | Core Platform | Open |
| GET | /investment/construction/runs/{uid} | Read one Portfolio Construction 2.0 evidence record | investment:read | Core Platform | Open |
| GET | /investment/derivatives/futures | Analyze an observed futures contract curve | investment:read | Core Platform | Open |
| GET | /investment/derivatives/options | Analyze an observed option chain with IV, Greeks, smile and term-structure evidence | investment:read | Core Platform | Open |
| GET | /investment/derivatives/snapshots | Read sealed observed-derivatives evidence snapshots | investment:read | Core Platform | Open |
| POST | /investment/derivatives/strategy | Calculate a deterministic multi-leg option expiry payoff grid | investment:run | Core Platform | Open |
| POST | /investment/derivatives/synthetic-options | Generate a sealed FINANCEGPT SYNTHETIC option chain from a promoted LQM | investment:run | Core Platform | Open |
| GET | /investment/derivatives/synthetic-options/runs | Read sealed FINANCEGPT SYNTHETIC option-chain runs | investment:read | Core Platform | Open |
| GET | /investment/execution/batches | List governed investment execution batches | investment:read | Core Platform | Open |
| POST | /investment/execution/batches | Create an execution batch from an approved rebalance proposal | investment:execute | Core Platform | Open |
| POST | /investment/execution/batches/{uid}/execute | Execute an approved governed investment order batch | investment:execute | Core Platform | Open |
| POST | /investment/execution/batches/{uid}/reconcile | Reconcile an investment execution batch with broker/custodian evidence | investment:execute | Core Platform | Open |
| POST | /investment/execution/batches/{uid}/submit | Submit an investment order batch for approval | investment:execute | Core Platform | Open |
| GET | /investment/generative-markets/runs | Read evidence-sealed generative market scenario runs | investment:read | Core Platform | Open |
| GET | /investment/governed-ai-operations | List governed AI investment operations | investment:read | Core Platform | Open |
| POST | /investment/governed-ai-operations | Create a shadow or governed-review investment operation | investment:run | Core Platform | Open |
| GET | /investment/governed-ai-operations/{uid} | Read a governed AI investment operation and evidence graph | investment:read | Core Platform | Open |
| POST | /investment/governed-ai-operations/{uid}/rebalance | Create a governed rebalance proposal from sealed evidence | investment:run | Core Platform | Open |
| POST | /investment/governed-ai-operations/{uid}/refresh | Synchronize governed investment evidence and downstream state | investment:run | Core Platform | Open |
| POST | /investment/governed-ai-operations/{uid}/seal | Seal the governed upstream investment evidence packet | investment:run | Core Platform | Open |
| POST | /investment/governed-ai-operations/{uid}/submit | Request human approval for the governed rebalance proposal | investment:run | Core Platform | Open |
| GET | /investment/ontology | Read the published FinanceGPT Dynamic Industry Ontology | investment:read | Core Platform | Open |
| GET | /investment/ontology/companies/{symbol} | Read source-backed thematic exposure for a company | investment:read | Core Platform | Open |
| POST | /investment/ontology/companies/{symbol}/refresh | Extract and classify company activity against the published ontology | investment:run | Core Platform | Open |
| GET | /investment/ontology/nodes/{node}/universe | Rank the classified company universe by one controlled taxonomy node | investment:read | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/book/nav | Seal an observed-data portfolio NAV snapshot | investment:run | Core Platform | Open |
| GET | /investment/portfolios/{portfolio}/book/nav-snapshots | Read sealed portfolio NAV snapshots | investment:read | Core Platform | Open |
| GET | /investment/portfolios/{portfolio}/book/operations | Read portfolio front-to-back operating state | investment:read | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/book/reconcile | Reconcile settled investment-book positions to the latest custodian import | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/book/seed | Seed an empty portfolio book from opening evidence | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/book/synchronize | Synchronize governed trade and settlement evidence into the investment book | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/collateral-inventory | Seal observed collateral and HQLA inventory | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/construct | Run governed Portfolio Construction 2.0 | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/generative-markets | Generate an evidence-sealed synthetic counterfactual market scenario for a portfolio | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/margin-calls/{call}/collateral-proposal | Generate a non-executable collateral allocation proposal | investment:run | Core Platform | Open |
| GET | /investment/portfolios/{portfolio}/performance | Read evidence-linked portfolio time-weighted performance | investment:read | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/performance/calculate | Geometrically chain-link non-overlapping portfolio subperiod returns | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/performance/observations | Record a valuation subperiod and explicit external cash flow for portfolio performance | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/risk-compliance | Generate Institutional Risk & Compliance 2.0 evidence | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/scenarios | Run a deterministic governed portfolio stress scenario | investment:run | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/tax-harvest | Create a tax-harvest proposal without executing a trade | investment:run | Core Platform | Open |
| GET | /investment/portfolios/{portfolio}/tax-lots | List governed tax-lot records for an adopted portfolio | investment:read | Core Platform | Open |
| POST | /investment/portfolios/{portfolio}/theme-watch | Seal a portfolio thematic attribution and drift snapshot | investment:run | Core Platform | Open |
| GET | /investment/reports | List approved/finalized investment client reports | investment:read | Core Platform | Open |
| GET | /investment/risk | List EquityGPT Professional risk snapshots | investment:read | Core Platform | Open |
| GET | /investment/risk-compliance/runs | Read Institutional Risk & Compliance 2.0 runs | investment:read | Core Platform | Open |
| GET | /investment/risk-compliance/runs/{uid} | Read one Institutional Risk & Compliance 2.0 evidence record | investment:read | Core Platform | Open |
| GET | /investment/theme-watch | Read Thematic Factor Model and Theme Watch evidence | investment:read | Core Platform | Open |
| POST | /investment/theme-watch/factors | Estimate point-in-time thematic factor returns | investment:run | Core Platform | Open |
| GET | /investment/themes | Read saved FinanceGPT thematic universes | investment:read | Core Platform | Open |
| POST | /investment/themes/discover | Discover and save an evidence-backed thematic universe from free text | investment:run | Core Platform | Open |
| GET | /investment/themes/universes/{universe} | Read one saved thematic universe and its evidence | investment:read | Core Platform | Open |
| GET | /investment/themes/universes/{universe}/analytics | Read saved thematic-universe analytics | investment:read | Core Platform | Open |
| POST | /investment/themes/universes/{universe}/model-portfolio | Hand a saved thematic universe to a draft model portfolio | investment:run | Core Platform | Open |
| POST | /investment/themes/universes/{universe}/watchlist | Hand a saved thematic universe to an investment watchlist | investment:run | Core Platform | Open |
| GET | /marketplace/listings | Discover verified marketplace APIs, models, datasets and FinanceGPT-native workflows | marketplace:read | Core Platform | Open |
| POST | /marketplace/{slug}/invoke | Invoke an actively subscribed verified marketplace listing, including a governed native workflow | marketplace:invoke | Core Platform | Open |
| POST | /ml/anomaly | Run approved financial anomaly inference on the latest synchronized derived feature vector | ml:inference | Core Platform | Open |
| GET | /ml/models | List approved active FinanceGPT ML model cards available to the workspace | ml:read | Core Platform | Open |
| POST | /ml/scenarios | Generate model-sampled financial stress scenarios from an approved VAE | ml:inference | Core Platform | Open |
| POST | /oauth/token | Issue an OAuth 2.0 client-credentials service token | Public / authentication-specific | Core Platform | Open |
| GET | /trust/evidence | Read FinanceGPT enterprise trust evidence | trust:read | Core Platform | Open |
| POST | /trust/evidence-packs | Create a sealed workspace enterprise-evidence pack | trust:write | Core Platform | Open |
| GET | /trust/provenance | Read workspace AI-content provenance records | trust:read | Core Platform | Open |
| POST | /trust/provenance | Register governed AI-content provenance | trust:write | Core Platform | Open |
| POST | /trust/verify | Verify recorded FinanceGPT provenance evidence | trust:read | Core Platform | Open |
| GET | /workspace | Get the credential's FinanceGPT workspace | workspace:read | Core Platform | Open |
| GET | /acquisition/discovery-catalog | Read the FinanceGPT authoritative public discovery catalog | commercial:read | Developer & Commercial | Open |
| GET | /acquisition/metrics | Read measured acquisition and AI-referral evidence for the active commercial context | commercial:read | Developer & Commercial | Open |
| GET | /commercial/billing | Read verified workspace subscription state | commercial:read | Developer & Commercial | Open |
| GET | /commercial/catalog | Read the canonical FinanceGPT commercial plan catalog | commercial:read | Developer & Commercial | Open |
| POST | /commercial/checkout-intents | Create an authenticated self-service FinanceGPT checkout intent | commercial:write | Developer & Commercial | Open |
| GET | /commercial/checkout-intents/{uid} | Read a FinanceGPT checkout intent | commercial:write | Developer & Commercial | Open |
| GET | /commercial/entitlements | Read the active workspace commercial profile and entitlement matrix | commercial:read | Developer & Commercial | Open |
| POST | /commercial/entitlements/check | Evaluate a FinanceGPT commercial entitlement | commercial:read | Developer & Commercial | Open |
| GET | /commercial/financial-operations | Read FinanceGPT Financial Operations commercial status | commercial:read | Developer & Commercial | Open |
| GET | /commercial/financial-operations/readiness | Read Financial Operations implementation and live-readiness controls | commercial:read | Developer & Commercial | Open |
| POST | /commercial/financial-operations/request | Request FinanceGPT Financial Operations qualification | commercial:write | Developer & Commercial | Open |
| POST | /commercial/financial-operations/snapshot | Capture a Financial Operations customer-success snapshot | commercial:write | Developer & Commercial | Open |
| GET | /commercial/financial-operations/value | Read measured Financial Operations customer-success evidence | commercial:read | Developer & Commercial | Open |
| GET | /commercial/restricted-autonomy | Read Restricted Autonomous Operations commercial status | commercial:read | Developer & Commercial | Open |
| GET | /commercial/restricted-autonomy/readiness | Read Restricted Autonomous Operations commercial readiness | commercial:read | Developer & Commercial | Open |
| GET | /commercial/restricted-autonomy/renewal | Read Restricted Autonomous Operations renewal status | commercial:read | Developer & Commercial | Open |
| POST | /commercial/restricted-autonomy/request | Request Restricted Autonomous Operations commercial review | commercial:write | Developer & Commercial | Open |
| POST | /commercial/restricted-autonomy/snapshot | Capture Restricted Autonomous Operations measured outcomes | commercial:write | Developer & Commercial | Open |
| GET | /commercial/restricted-autonomy/value | Read measured Restricted Autonomous Operations outcomes | commercial:read | Developer & Commercial | Open |
| GET | /commercial/upgrade-opportunities | List unresolved product-intent commercial upgrade opportunities for the active workspace | commercial:read | Developer & Commercial | Open |
| POST | /commercial/upgrade-opportunities/{uid}/interactions | Record a bounded interaction with one product-led upgrade opportunity | commercial:write | Developer & Commercial | Open |
| POST | /commercial/upgrade-recommendations | Resolve the lowest appropriate commercial path for a real product-intent trigger | commercial:write | Developer & Commercial | Open |
| GET | /commercial/usage | Read normalized FinanceGPT commercial usage and allowances | commercial:read | Developer & Commercial | Open |
| POST | /commercial/usage/budgets | Configure a workspace commercial usage budget | commercial:write | Developer & Commercial | Open |
| GET | /commercial/usage/economics | Read workspace usage economics evidence | commercial:read | Developer & Commercial | Open |
| POST | /commercial/usage/policy | Configure explicit workspace usage-billing consent | commercial:write | Developer & Commercial | Open |
| GET | /commercial/value | Read FinanceGPT Value & Outcome Intelligence for the active workspace | commercial:read | Developer & Commercial | Open |
| GET | /commercial/value/evidence | Export FinanceGPT value evidence for the active workspace | commercial:read | Developer & Commercial | Open |
| GET | /commercial/value/snapshots | Read sealed FinanceGPT value metric snapshots | commercial:read | Developer & Commercial | Open |
| GET | /actions/agentic | Read machine financial identities, delegations, signed actions and kill switches | actions:read | Financial Actions | Open |
| POST | /actions/agentic/delegations/{uid}/approve | Independently approve a machine financial delegation | actions:execute | Financial Actions | Open |
| POST | /actions/agentic/delegations/{uid}/revoke | Revoke a machine delegation and release open reservations | actions:execute | Financial Actions | Open |
| POST | /actions/agentic/identities | Register a versioned machine financial identity | actions:create | Financial Actions | Open |
| POST | /actions/agentic/identities/{uid}/activate | Activate a machine financial identity after verification | actions:create | Financial Actions | Open |
| POST | /actions/agentic/identities/{uid}/delegations | Create a bounded machine financial delegation | actions:create | Financial Actions | Open |
| POST | /actions/agentic/identities/{uid}/versions | Record a new machine financial-identity version | actions:create | Financial Actions | Open |
| POST | /actions/agentic/kill-switches | Engage a workspace, machine-identity or delegation execution kill switch | actions:execute | Financial Actions | Open |
| POST | /actions/agentic/kill-switches/{uid}/release | Release a machine financial kill switch | actions:execute | Financial Actions | Open |
| POST | /actions/agentic/proposals | Submit an Ed25519-signed machine Financial Action proposal | actions:create | Financial Actions | Open |
| POST | /actions/agentic/{uid}/execute | Execute a machine-delegated Financial Action using a fresh signed execution instruction | actions:autonomous | Financial Actions | Open |
| GET | /actions/approval-graphs | List governed Financial Action approval graphs | actions:read | Financial Actions | Open |
| GET | /actions/assurance | Read workspace Financial Actions assurance status | actions:read | Financial Actions | Open |
| POST | /actions/assurance/runs | Run the workspace Financial Actions assurance suite | actions:execute | Financial Actions | Open |
| GET | /actions/authorities | List active and historical action-scoped authorities for the workspace | actions:read | Financial Actions | Open |
| GET | /actions/autonomy | Read restricted institutional autonomous-operations status | actions:read | Financial Actions | Open |
| POST | /actions/autonomy/application | Request institutional assessment for autonomous financial operations | actions:create | Financial Actions | Open |
| POST | /actions/autonomy/assessment-evidence | Submit evidence to an open institutional autonomy assessment | actions:create | Financial Actions | Open |
| POST | /actions/autonomy/institutional-mandates | Create a draft restricted autonomous financial mandate | actions:create | Financial Actions | Open |
| POST | /actions/autonomy/institutional-mandates/{uid}/submit | Submit a restricted autonomous mandate for FinanceGPT platform approval | actions:create | Financial Actions | Open |
| GET | /actions/counterparties | List governed Financial Action counterparties and current settlement-destination status | actions:read | Financial Actions | Open |
| GET | /actions/credit-corporate | List governed credit, collections and corporate-action links | actions:read | Financial Actions | Open |
| POST | /actions/credit-corporate | Create a governed credit, collection or corporate action from a sealed source record | actions:create | Financial Actions | Open |
| GET | /actions/credit-corporate/arrangements | List accepted settlement and repayment arrangements | actions:read | Financial Actions | Open |
| POST | /actions/credit-corporate/arrangements | Register an accepted settlement or repayment arrangement | actions:create | Financial Actions | Open |
| GET | /actions/credit-corporate/instructions | List governed corporate and treasury instructions | actions:read | Financial Actions | Open |
| POST | /actions/credit-corporate/instructions | Register a governed corporate instruction | actions:create | Financial Actions | Open |
| GET | /actions/credit-corporate/obligations | List governed credit and collection obligations | actions:read | Financial Actions | Open |
| POST | /actions/credit-corporate/obligations | Register a governed obligation source record | actions:create | Financial Actions | Open |
| POST | /actions/credit-corporate/{uid}/checks | Record a versioned credit, collection or corporate-action domain control | actions:execute | Financial Actions | Open |
| POST | /actions/credit-corporate/{uid}/refresh | Refresh source-record scope and invalidate stale approval when material evidence changed | actions:execute | Financial Actions | Open |
| GET | /actions/execution-instructions | List governed Payments & Treasury execution instructions | actions:read | Financial Actions | Open |
| GET | /actions/execution-profiles | List Payments & Treasury execution profiles and engaged kill switches | actions:read | Financial Actions | Open |
| GET | /actions/intents | List governed Financial Action envelopes for the active workspace | actions:read | Financial Actions | Open |
| POST | /actions/intents | Create a governed Financial Action envelope | actions:create | Financial Actions | Open |
| GET | /actions/intents/{uid} | Read one Financial Action envelope and current control-plane state | actions:read | Financial Actions | Open |
| GET | /actions/intents/{uid}/approval-run | Read the current Financial Action approval run and quorum progress | actions:read | Financial Actions | Open |
| GET | /actions/intents/{uid}/evidence | Read structured Financial Action control and evidence lineage | actions:read | Financial Actions | Open |
| POST | /actions/intents/{uid}/execute | Execute an authorized Financial Action through its separate execution authority | actions:execute | Financial Actions | Open |
| POST | /actions/intents/{uid}/reconcile | Reconcile an executed Financial Action against settlement evidence | actions:read | Financial Actions | Open |
| POST | /actions/intents/{uid}/submit | Submit a Financial Action for governed human approval | actions:create | Financial Actions | Open |
| GET | /actions/investment-execution | List investment order batches converged into governed Financial Actions | investment:read | Financial Actions | Open |
| POST | /actions/investment-execution | Adopt an investment order batch into the Financial Actions control plane | investment:execute | Financial Actions | Open |
| GET | /actions/investment-execution/{uid} | Read one governed investment execution convergence record | investment:read | Financial Actions | Open |
| POST | /actions/investment-execution/{uid}/checks | Record a versioned investment pre-trade control result | investment:execute | Financial Actions | Open |
| POST | /actions/investment-execution/{uid}/confirmations | Record broker trade-confirmation evidence without treating it as settlement | investment:execute | Financial Actions | Open |
| POST | /actions/investment-execution/{uid}/custody | Record independent custody settlement evidence and run canonical reconciliation | investment:execute | Financial Actions | Open |
| POST | /actions/investment-execution/{uid}/refresh | Refresh material investment-order scope and invalidate stale approval when needed | investment:execute | Financial Actions | Open |
| GET | /actions/policies | List scoped Financial Actions policies and conditional rules | actions:read | Financial Actions | Open |
| GET | /actions/reconciliation | List Financial Action settlement and reconciliation status | actions:read | Financial Actions | Open |
| GET | /actions/reconciliation-exceptions | List Financial Action reconciliation exceptions | actions:read | Financial Actions | Open |
| POST | /actions/reconciliation-exceptions/{uid}/resolve | Resolve a Financial Action reconciliation exception with retained evidence | actions:execute | Financial Actions | Open |
| GET | /actions/risk-rules | List active and historical dynamic Financial Action risk rules | actions:read | Financial Actions | Open |
| GET | /companies | List company-finance workspaces | financial:analysis:read | Financial Data & Planning | Open |
| GET | /companies/{company} | Read company finance profile and data coverage | financial:analysis:read | Financial Data & Planning | Open |
| GET | /companies/{company}/analysis | Read company analysis, financial resilience, DCF and linked forecast | financial:analysis:read | Financial Data & Planning | Open |
| GET | /companies/{company}/financials | Read normalized financial periods with source provenance | financial:analysis:read | Financial Data & Planning | Open |
| GET | /companies/{company}/ratios | Read deterministic financial ratios | financial:analysis:read | Financial Data & Planning | Open |
| POST | /companies/{company}/scenarios | Run deterministic company revenue and expense scenarios | financial:analysis:run | Financial Data & Planning | Open |
| POST | /companies/{company}/valuations | Run free-cash-flow DCF valuation | financial:analysis:run | Financial Data & Planning | Open |
| GET | /data/datasets | List datasets currently licensed for FinanceGPT API redistribution | data:reference:read | Financial Data & Planning | Open |
| GET | /data/economics/series | Search licence-governed economic series | data:economics:read | Financial Data & Planning | Open |
| GET | /data/economics/series/{key} | Get an economic series profile | data:economics:read | Financial Data & Planning | Open |
| GET | /data/economics/series/{key}/observations | Get economic observations and vintages | data:economics:read | Financial Data & Planning | Open |
| GET | /data/instruments | Search the canonical FinanceGPT securities master | data:reference:read | Financial Data & Planning | Open |
| GET | /data/instruments/{uid} | Get a canonical instrument, issuer, venue and identifiers | data:reference:read | Financial Data & Planning | Open |
| GET | /data/instruments/{uid}/corporate-actions | Get normalized corporate actions | data:market:read | Financial Data & Planning | Open |
| GET | /data/instruments/{uid}/fundamentals | Get standardized fundamental facts | data:fundamentals:read | Financial Data & Planning | Open |
| GET | /data/instruments/{uid}/prices | Get licence-governed normalized price history | data:market:read | Financial Data & Planning | Open |
| GET | /data/tables | Read governed FinanceGPT Data Studio tables | data:tables:read | Financial Data & Planning | Open |
| GET | /data/tables/{uid} | Read one governed Data Studio table and bounded preview | data:tables:read | Financial Data & Planning | Open |
| POST | /data/tables/{uid}/ask | Plan and execute a governed natural-language Data Studio operation | data:tables:run | Financial Data & Planning | Open |
| POST | /data/tables/{uid}/operations | Execute an allow-listed deterministic Data Studio operation pipeline | data:tables:run | Financial Data & Planning | Open |
| GET | /financial/snapshots | List normalized connected financial snapshots | financial:read | Financial Data & Planning | Open |
| GET | /financial/transactions | List normalized connected financial transactions | financial:read | Financial Data & Planning | Open |
| GET | /planning/forecasts | List governed FinanceGPT forecasts | planning:read | Financial Data & Planning | Open |
| POST | /planning/forecasts | Generate and persist a backtest-selected forecast | planning:forecast:create | Financial Data & Planning | Open |
| GET | /knowledge/bases | List accessible FinanceGPT Knowledge Intelligence bases | Public / authentication-specific | Knowledge Intelligence | Open |
| GET | /knowledge/documents | List workspace-visible ready knowledge documents | Public / authentication-specific | Knowledge Intelligence | Open |
| POST | /knowledge/documents | Ingest a document into a workspace-visible knowledge base | Public / authentication-specific | Knowledge Intelligence | Open |
| GET | /knowledge/documents/{uid} | Read knowledge document metadata and lineage counts | Public / authentication-specific | Knowledge Intelligence | Open |
| POST | /knowledge/query | Ask FinanceGPT against permission-scoped Knowledge Intelligence evidence | Public / authentication-specific | Knowledge Intelligence | Open |
| GET | /lqm/commercial-model | Read the governed LQM commercial model | lqm:build:read | LQM Builder | Open |
| POST | /lqm/datasets/{dataset}/contracts | Seal a numeric LQM training-data contract | lqm:build:write | LQM Builder | Open |
| GET | /lqm/developer-manifest | Read the machine-readable LQM developer platform contract | lqm:build:read | LQM Builder | Open |
| GET | /lqm/evaluation-runs/{evaluationUid} | Read a governed LQM evaluation run | lqm:build:read | LQM Builder | Open |
| GET | /lqm/evidence-packets/{packetUid} | Read one immutable LQM Evidence Packet | lqm:build:read | LQM Builder | Open |
| POST | /lqm/evidence-packets/{packetUid}/verify | Independently verify an LQM Evidence Packet and model evidence chain | lqm:build:run | LQM Builder | Open |
| GET | /lqm/models | List governed workspace LQM registry records | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models | Register a quantitative LQM before training | lqm:build:write | LQM Builder | Open |
| GET | /lqm/models/{uid} | Read an LQM registry record and its sealed training specifications | lqm:build:read | LQM Builder | Open |
| GET | /lqm/models/{uid}/developer-manifest | Read model-specific LQM developer readiness | lqm:build:read | LQM Builder | Open |
| GET | /lqm/models/{uid}/drift-assessments | List LQM drift assessments | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/drift-assessments | Run deterministic LQM drift assessment | lqm:build:run | LQM Builder | Open |
| POST | /lqm/models/{uid}/evaluate | Evaluate a sealed LQM checkpoint | lqm:build:run | LQM Builder | Open |
| GET | /lqm/models/{uid}/evaluations | List LQM checkpoint evaluations | lqm:build:read | LQM Builder | Open |
| GET | /lqm/models/{uid}/evidence-packets | List sealed Evidence Packets for an LQM | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/evidence-packets | Generate an Evidence Packet from a passed LQM checkpoint | lqm:build:run | LQM Builder | Open |
| GET | /lqm/models/{uid}/evidence-schema | Read the versioned LQM Evidence Packet schema | lqm:build:read | LQM Builder | Open |
| GET | /lqm/models/{uid}/operations-policy | Read governed LQM training operations policy | lqm:build:read | LQM Builder | Open |
| PUT | /lqm/models/{uid}/operations-policy | Configure LQM drift and retraining operations | lqm:build:write | LQM Builder | Open |
| POST | /lqm/models/{uid}/promote | Promote an evaluated LQM checkpoint into Quant Models | lqm:promote:write | LQM Builder | Open |
| GET | /lqm/models/{uid}/promotions | List governed LQM promotions for a workspace model | lqm:build:read | LQM Builder | Open |
| GET | /lqm/models/{uid}/publications | List governed model-hub publications for an LQM | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/publish | Publish an evaluated LQM checkpoint to the configured model hub | lqm:publish:write | LQM Builder | Open |
| GET | /lqm/models/{uid}/retraining-requests | List governed LQM retraining requests | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/retraining-requests | Create an LQM retraining request | lqm:build:write | LQM Builder | Open |
| GET | /lqm/models/{uid}/training-runs | List governed VAE-GAN training runs for an LQM | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/training-runs | Queue a sealed LQM VAE-GAN training run | lqm:build:run | LQM Builder | Open |
| GET | /lqm/models/{uid}/training-specs | List immutable pre-training specifications for an LQM | lqm:build:read | LQM Builder | Open |
| POST | /lqm/models/{uid}/training-specs | Seal a reproducible VAE-GAN training specification | lqm:build:write | LQM Builder | Open |
| GET | /lqm/platform | Read the governed LQM Builder platform foundation | lqm:build:read | LQM Builder | Open |
| POST | /lqm/promotions/{promotionUid}/retire | Retire an active LQM Quant Models promotion | lqm:promote:write | LQM Builder | Open |
| GET | /lqm/publications/{publicationUid} | Read an LQM model-hub publication and supply-chain evidence | lqm:build:read | LQM Builder | Open |
| POST | /lqm/retraining-requests/{requestUid}/advance | Advance an approved LQM retraining lifecycle | lqm:build:run | LQM Builder | Open |
| POST | /lqm/retraining-requests/{requestUid}/decision | Decide an LQM retraining request | lqm:build:write | LQM Builder | Open |
| GET | /lqm/training-runs/{runUid} | Read a governed LQM training run and checkpoint evidence | lqm:build:read | LQM Builder | Open |
| GET | /lqm/usage-evidence | Read workspace LQM usage evidence | lqm:build:read | LQM Builder | Open |
| POST | /lqm/workflow-outcomes | Record a workspace LQM workflow outcome observation | lqm:build:write | LQM Builder | Open |
| GET | /generative/models | List approved FinanceGPT generative financial models | generative:models:read | Quant & Models | Open |
| POST | /generative/paths | Generate reproducible multi-period synthetic financial stress paths | generative:inference | Quant & Models | Open |
| GET | /generative/runs | Read workspace generative-model run history | generative:models:read | Quant & Models | Open |
| GET | /generative/runs/{uid} | Retrieve one reproducible generative finance run | generative:models:read | Quant & Models | Open |
| POST | /generative/scenarios | Generate reproducible regime-conditioned financial scenarios | generative:inference | Quant & Models | Open |
| POST | /quant/compute/backtests | Queue a governed historical backtest | quant:compute:run | Quant & Models | Open |
| GET | /quant/compute/jobs | List workspace Quant Compute Cloud jobs | quant:compute:read | Quant & Models | Open |
| GET | /quant/compute/jobs/{uid} | Retrieve one Quant Compute Cloud job and completed result | quant:compute:read | Quant & Models | Open |
| POST | /quant/compute/jobs/{uid}/cancel | Cancel a queued Quant Compute Cloud job | quant:compute:run | Quant & Models | Open |
| POST | /quant/compute/optimizations | Queue a bounded parameter-grid optimization over an approved FinanceGPT model | quant:compute:run | Quant & Models | Open |
| POST | /quant/compute/simulations | Queue a seeded Monte Carlo simulation | quant:compute:run | Quant & Models | Open |
| GET | /quant/features | List governed FinanceGPT point-in-time feature definitions | quant:features:read | Quant & Models | Open |
| GET | /quant/features/{key} | Get one governed financial feature definition | quant:features:read | Quant & Models | Open |
| GET | /quant/features/{key}/values | Get look-ahead-safe API-releasable feature values for a canonical instrument | quant:features:read | Quant & Models | Open |
| GET | /quant/model-runs | Read workspace quantitative-model execution history | quant:models:read | Quant & Models | Open |
| GET | /quant/model-tournaments | List workspace forecast-model tournaments | quant:models:read | Quant & Models | Open |
| POST | /quant/model-tournaments | Run a governed holdout forecast-model tournament | quant:models:run | Quant & Models | Open |
| GET | /quant/model-tournaments/{uid} | Retrieve one governed forecast-model tournament | quant:models:read | Quant & Models | Open |
| GET | /quant/models | List validated deterministic FinanceGPT quantitative models | quant:models:read | Quant & Models | Open |
| GET | /quant/models/{key} | Get one quantitative model card, schema, methodology and validation evidence | quant:models:read | Quant & Models | Open |
| POST | /quant/models/{key}/run | Execute a validated deterministic quantitative model | quant:models:run | Quant & Models | Open |
| GET | /quant/projects | List workspace quantitative research projects | quant:research:read | Quant & Models | Open |
| POST | /quant/research/runs | Run a governed feature-quality experiment against a sealed snapshot | quant:research:run | Quant & Models | Open |
| POST | /quant/research/snapshots | Generate a sealed point-in-time research feature matrix | quant:research:run | Quant & Models | Open |
| GET | /quant/research/snapshots/{uid} | Retrieve a sealed research snapshot and its point-in-time feature rows | quant:research:read | Quant & Models | Open |
| GET | /quant/statistical-models | List FinanceGPT forecasting, econometrics, volatility, factor and statistical-risk models | quant:models:read | Quant & Models | Open |
| GET | /agent-execution/workflows | List published immutable Workflow Studio tools allowed for the signed external agent | agent:execution:read | Workflows | Open |
| POST | /agent-execution/workflows/a2a | Invoke the signed Workflow Studio agent-to-agent gateway | agent:execution:invoke | Workflows | Open |
| POST | /agent-execution/workflows/mcp | Invoke the signed Workflow Studio MCP gateway | agent:execution:invoke | Workflows | Open |
| GET | /agent-execution/workflows/runs/{uid} | Read an external-agent workflow invocation | agent:execution:read | Workflows | Open |
| POST | /agent-execution/workflows/runs/{uid}/cancel | Request cancellation of the client's own non-terminal workflow invocation | agent:execution:invoke | Workflows | Open |
| GET | /agent-execution/workflows/runs/{uid}/outcome | Read measured workflow outcome evidence | agent:execution:read | Workflows | Open |
| POST | /agent-execution/workflows/tools/{uid}/runs | Invoke a published immutable production workflow | agent:execution:invoke | Workflows | Open |
| GET | /agent-execution/workflows/use-cases | List the canonical FinanceGPT workflow use-case catalogue | agent:execution:read | Workflows | Open |
| POST | /workflow-event-mesh/{source_uid} | Deliver a signed external event to an immutable Workflow Studio version | Public / authentication-specific | Workflows | Open |
| GET | /workflow-studio | Read Workflow Studio templates, durable runs and catalogue status | workflow:read | Workflows | Open |
| GET | /workflow-studio/admission | Read workload admission policy, capacity context and recent decisions | workflow:read | Workflows | Open |
| GET | /workflow-studio/admission/decisions | Read recent durable workflow admission decisions | workflow:read | Workflows | Open |
| PUT | /workflow-studio/admission/policy | Update the workspace workload admission policy | workflow:manage | Workflows | Open |
| POST | /workflow-studio/events/{key} | Trigger a configured Workflow Studio event idempotently | workflow:manage | Workflows | Open |
| GET | /workflow-studio/finops | Read Workflow FinOps and capacity intelligence | Public / authentication-specific | Workflows | Open |
| POST | /workflow-studio/finops/alerts/{uid}/acknowledge | Acknowledge a Workflow FinOps alert | Public / authentication-specific | Workflows | Open |
| POST | /workflow-studio/finops/alerts/{uid}/resolve | Resolve a Workflow FinOps alert | Public / authentication-specific | Workflows | Open |
| PUT | /workflow-studio/finops/policy | Update observational Workflow FinOps policy | Public / authentication-specific | Workflows | Open |
| POST | /workflow-studio/finops/refresh | Refresh workflow cost attribution and capacity evidence | Public / authentication-specific | Workflows | Open |
| POST | /workflow-studio/nodes/{uid}/review | Record a human review for a governed workflow node | workflow:manage | Workflows | Open |
| GET | /workflow-studio/operations | Read workspace Workflow Reliability operations, SLO evidence and runtime incidents | workflow:read | Workflows | Open |
| POST | /workflow-studio/operations/incidents/{uid}/acknowledge | Acknowledge a workspace Workflow Reliability runtime incident | workflow:manage | Workflows | Open |
| POST | /workflow-studio/operations/incidents/{uid}/resolve | Resolve a workspace Workflow Reliability runtime incident | workflow:manage | Workflows | Open |
| GET | /workflow-studio/qos | Read Workflow Queue QoS policy, latest fairness evidence and recent dispatch decisions | workflow:read | Workflows | Open |
| GET | /workflow-studio/qos/decisions | Read recent durable S20 dispatch decisions | workflow:read | Workflows | Open |
| PUT | /workflow-studio/qos/policy | Update workspace weighted-fair dispatch and queue-age QoS policy | workflow:manage | Workflows | Open |
| GET | /workflow-studio/runs/{uid} | Read durable Workflow Studio state and node evidence | workflow:read | Workflows | Open |
| POST | /workflow-studio/runs/{uid}/{action} | Pause, resume, cancel or replay a durable workflow run | workflow:manage | Workflows | Open |
| PUT | /workflow-studio/templates/{id}/admission-policy | Update a workflow-specific admission policy and policy-controlled priority class | workflow:manage | Workflows | Open |
| GET | /workflow-studio/templates/{id}/change-safety | Read Workflow Studio test suites, validation campaigns and production-promotion safety evidence | workflow:read | Workflows | Open |
| PUT | /workflow-studio/templates/{id}/finops-policy | Update workflow-specific observational FinOps policy | Public / authentication-specific | Workflows | Open |
| PUT | /workflow-studio/templates/{id}/qos-policy | Update workflow-specific weighted-fair dispatch and queue-age QoS policy | workflow:manage | Workflows | Open |
| PUT | /workflow-studio/templates/{id}/reliability | Configure a workspace-owned workflow reliability policy | workflow:manage | Workflows | Open |
| POST | /workflow-studio/templates/{id}/reliability/hold | Place a local hold on new production starts without cancelling existing runs | workflow:manage | Workflows | Open |
| POST | /workflow-studio/templates/{id}/reliability/release-hold | Release a local workflow production hold after operator review | workflow:manage | Workflows | Open |
| POST | /workflow-studio/templates/{id}/runs | Start an idempotent durable workflow run | workflow:manage | Workflows | Open |
| POST | /workflow-studio/templates/{id}/test-suites | Create a workspace-scoped workflow regression test suite | workflow:manage | Workflows | Open |
| POST | /workflow-studio/test-cases/{uid}/toggle | Enable or disable a workflow test case | workflow:manage | Workflows | Open |
| POST | /workflow-studio/test-suites/{uid}/cases | Add an encrypted workflow test case and assertion contract | workflow:manage | Workflows | Open |
| GET | /workflow-studio/use-cases | List the canonical FinanceGPT workflow use-case catalogue | workflow:read | Workflows | Open |
| POST | /workflow-studio/use-cases/{uid}/install | Install a use case as an editable Workflow Studio draft | workflow:manage | Workflows | Open |
| POST | /workflow-studio/validation-campaigns/{uid}/review | Explicitly approve or reject a high-risk workflow change after successful validation | workflow:manage | Workflows | Open |
| POST | /workflow-studio/versions/{uid}/validate | Run a side-effect-free S16 validation campaign against an exact draft or testing version | workflow:manage | Workflows | Open |
| POST | /workflows/events/{key} | Submit an idempotent encrypted event into the FinanceGPT workflow runtime | workflow:manage | Workflows | Open |
| GET | /workflows/runs | List finance workflow runs, task status and reporting-pack status | workflow:read | Workflows | Open |
| GET | /workflows/runtime/{id} | Read durable node execution state for a finance workflow run | workflow:read | Workflows | Open |