Skip to main content
RECOGNITION · PROGRAMMES · ECOSYSTEM · TRUST FinanceGPT Labs
FinanceGPT Developer Platform

API Reference

Find the endpoint you need, inspect its contract, then test it in the sandbox Explorer or copy it into your application.

Start with an outcome

Jump into the contract by intent instead of scanning hundreds of operations.

Find an endpoint

151 matching operations · 388 published total
Reference JSON

Operations

Open a contract for parameters and responses, or move directly into the authenticated sandbox Explorer.
EndpointWhat it doesScopeGroup
POST/agent-execution/a2a Invoke the signed FinanceGPT agent-to-agent execution gateway agent:execution:invoke Agents & MCP Contract Try
GET/agent-execution/actions/{uid} Read governed Financial Action status agent:execution:read Agents & MCP Contract Try
GET/agent-execution/actions/{uid}/assurance Read Financial Actions assurance evidence agent:execution:read Agents & MCP Contract Try
POST/agent-execution/actions/{uid}/execute Request execution of an already-authorized Financial Action agent:execution:execute Agents & MCP Contract Try
GET/agent-execution/actions/{uid}/reconciliation Read Financial Action reconciliation evidence agent:execution:read Agents & MCP Contract Try
POST/agent-execution/actions/{uid}/submit Submit an external-agent Financial Action for approval agent:execution:submit Agents & MCP Contract Try
GET/agent-execution/capabilities Read signed external-agent execution capabilities agent:execution:read Agents & MCP Contract Try
POST/agent-execution/mcp Invoke the signed FinanceGPT Financial Actions MCP execution gateway agent:execution:invoke Agents & MCP Contract Try
POST/agent-execution/proposals Propose a governed Financial Action from an external agent agent:execution:propose Agents & MCP Contract Try
GET/agent-execution/webhooks List signed Financial Action and workflow lifecycle webhooks agent:execution:webhooks Agents & MCP Contract Try
POST/agent-execution/webhooks Register a signed HTTPS Financial Action or workflow lifecycle webhook agent:execution:webhooks Agents & MCP Contract Try
GET/ai/model-selections Read Universal Model Switching choices for the active workspace ai:models:read AI Runtime & Governance Contract Try
GET/finance-core/accounts Read ledger accounts finance-core:read Core Platform Contract Try
GET/finance-core/accruals Read accrual schedules finance-core:read Core Platform Contract Try
GET/finance-core/bank-accounts Read bank accounts finance-core:read Core Platform Contract Try
GET/finance-core/bank-statements Read bank statement batches finance-core:read Core Platform Contract Try
GET/finance-core/close/cycles Read continuous-close cycles finance-core:close:read Core Platform Contract Try
GET/finance-core/consolidation-groups Read consolidation groups finance-core:read Core Platform Contract Try
GET/finance-core/control-policies Read accounting control policies finance-core:read Core Platform Contract Try
GET/finance-core/entities Read accounting entities finance-core:read Core Platform Contract Try
GET/finance-core/fixed-assets Read fixed assets finance-core:read Core Platform Contract Try
GET/finance-core/fx-rate-sets Read FX rate sets finance-core:read Core Platform Contract Try
POST/finance-core/intake/submissions Submit structured accounting intake to the governed staging layer finance-core:intake:write Core Platform Contract Try
GET/finance-core/journals Read journal entries finance-core:read Core Platform Contract Try
GET/finance-core/ledgers Read general ledgers finance-core:read Core Platform Contract Try
GET/finance-core/payables Read payable documents finance-core:read Core Platform Contract Try
GET/finance-core/periods Read accounting periods finance-core:read Core Platform Contract Try
GET/finance-core/prepaids Read prepaid expense schedules finance-core:read Core Platform Contract Try
GET/finance-core/receivables Read receivable documents finance-core:read Core Platform Contract Try
GET/finance-core/recommendations Read accounting-agent recommendations finance-core:recommendations:read Core Platform Contract Try
GET/finance-core/reconciliations Read cash reconciliations finance-core:read Core Platform Contract Try
GET/finance-core/reports/snapshots Read financial-statement snapshots finance-core:reports:read Core Platform Contract Try
GET/finance-core/revenue-contracts Read accounting revenue contracts finance-core:read Core Platform Contract Try
GET/finance-core/settlements Read subledger settlements finance-core:read Core Platform Contract Try
GET/investment/book Read the workspace investment book control surface investment:read Core Platform Contract Try
GET/investment/governed-ai-operations List governed AI investment operations investment:read Core Platform Contract Try
POST/investment/governed-ai-operations/{uid}/rebalance Create a governed rebalance proposal from sealed evidence investment:run Core Platform Contract Try
POST/investment/governed-ai-operations/{uid}/refresh Synchronize governed investment evidence and downstream state investment:run Core Platform Contract Try
POST/investment/governed-ai-operations/{uid}/submit Request human approval for the governed rebalance proposal investment:run Core Platform Contract Try
POST/investment/ontology/companies/{symbol}/refresh Extract and classify company activity against the published ontology investment:run Core Platform Contract Try
POST/investment/portfolios/{portfolio}/book/seed Seed an empty portfolio book from opening evidence investment:run Core Platform Contract Try
POST/investment/portfolios/{portfolio}/book/synchronize Synchronize governed trade and settlement evidence into the investment book investment:run Core Platform Contract Try
POST/investment/portfolios/{portfolio}/construct Run governed Portfolio Construction 2.0 investment:run Core Platform Contract Try
POST/investment/portfolios/{portfolio}/risk-compliance Generate Institutional Risk & Compliance 2.0 evidence investment:run Core Platform Contract Try
POST/investment/portfolios/{portfolio}/theme-watch Seal a portfolio thematic attribution and drift snapshot investment:run Core Platform Contract Try
POST/investment/theme-watch/factors Estimate point-in-time thematic factor returns investment:run Core Platform Contract Try
POST/investment/themes/discover Discover and save an evidence-backed thematic universe from free text investment:run Core Platform Contract Try
POST/investment/themes/universes/{universe}/model-portfolio Hand a saved thematic universe to a draft model portfolio investment:run Core Platform Contract Try
POST/investment/themes/universes/{universe}/watchlist Hand a saved thematic universe to an investment watchlist investment:run Core Platform Contract Try
POST/ml/anomaly Run approved financial anomaly inference on the latest synchronized derived feature vector ml:inference Core Platform Contract Try
POST/ml/scenarios Generate model-sampled financial stress scenarios from an approved VAE ml:inference Core Platform Contract Try
GET/commercial/catalog Read the canonical FinanceGPT commercial plan catalog commercial:read Developer & Commercial Contract Try
POST/commercial/checkout-intents Create an authenticated self-service FinanceGPT checkout intent commercial:write Developer & Commercial Contract Try
GET/commercial/entitlements Read the active workspace commercial profile and entitlement matrix commercial:read Developer & Commercial Contract Try
GET/commercial/financial-operations Read FinanceGPT Financial Operations commercial status commercial:read Developer & Commercial Contract Try
GET/commercial/financial-operations/readiness Read Financial Operations implementation and live-readiness controls commercial:read Developer & Commercial Contract Try
POST/commercial/financial-operations/request Request FinanceGPT Financial Operations qualification commercial:write Developer & Commercial Contract Try
POST/commercial/financial-operations/snapshot Capture a Financial Operations customer-success snapshot commercial:write Developer & Commercial Contract Try
GET/commercial/financial-operations/value Read measured Financial Operations customer-success evidence commercial:read Developer & Commercial Contract Try
GET/commercial/restricted-autonomy/readiness Read Restricted Autonomous Operations commercial readiness commercial:read Developer & Commercial Contract Try
POST/commercial/restricted-autonomy/snapshot Capture Restricted Autonomous Operations measured outcomes commercial:write Developer & Commercial Contract Try
GET/actions/agentic Read machine financial identities, delegations, signed actions and kill switches actions:read Financial Actions Contract Try
POST/actions/agentic/delegations/{uid}/approve Independently approve a machine financial delegation actions:execute Financial Actions Contract Try
POST/actions/agentic/delegations/{uid}/revoke Revoke a machine delegation and release open reservations actions:execute Financial Actions Contract Try
POST/actions/agentic/identities Register a versioned machine financial identity actions:create Financial Actions Contract Try
POST/actions/agentic/identities/{uid}/activate Activate a machine financial identity after verification actions:create Financial Actions Contract Try
POST/actions/agentic/identities/{uid}/delegations Create a bounded machine financial delegation actions:create Financial Actions Contract Try
POST/actions/agentic/identities/{uid}/versions Record a new machine financial-identity version actions:create Financial Actions Contract Try
POST/actions/agentic/kill-switches Engage a workspace, machine-identity or delegation execution kill switch actions:execute Financial Actions Contract Try
POST/actions/agentic/kill-switches/{uid}/release Release a machine financial kill switch actions:execute Financial Actions Contract Try
POST/actions/agentic/proposals Submit an Ed25519-signed machine Financial Action proposal actions:create Financial Actions Contract Try
POST/actions/agentic/{uid}/execute Execute a machine-delegated Financial Action using a fresh signed execution instruction actions:autonomous Financial Actions Contract Try
GET/actions/approval-graphs List governed Financial Action approval graphs actions:read Financial Actions Contract Try
GET/actions/assurance Read workspace Financial Actions assurance status actions:read Financial Actions Contract Try
POST/actions/assurance/runs Run the workspace Financial Actions assurance suite actions:execute Financial Actions Contract Try
GET/actions/authorities List active and historical action-scoped authorities for the workspace actions:read Financial Actions Contract Try
GET/actions/autonomy Read restricted institutional autonomous-operations status actions:read Financial Actions Contract Try
POST/actions/autonomy/application Request institutional assessment for autonomous financial operations actions:create Financial Actions Contract Try
POST/actions/autonomy/assessment-evidence Submit evidence to an open institutional autonomy assessment actions:create Financial Actions Contract Try
POST/actions/autonomy/institutional-mandates Create a draft restricted autonomous financial mandate actions:create Financial Actions Contract Try
POST/actions/autonomy/institutional-mandates/{uid}/submit Submit a restricted autonomous mandate for FinanceGPT platform approval actions:create Financial Actions Contract Try
GET/actions/counterparties List governed Financial Action counterparties and current settlement-destination status actions:read Financial Actions Contract Try
GET/actions/credit-corporate List governed credit, collections and corporate-action links actions:read Financial Actions Contract Try
POST/actions/credit-corporate Create a governed credit, collection or corporate action from a sealed source record actions:create Financial Actions Contract Try
GET/actions/credit-corporate/arrangements List accepted settlement and repayment arrangements actions:read Financial Actions Contract Try
POST/actions/credit-corporate/arrangements Register an accepted settlement or repayment arrangement actions:create Financial Actions Contract Try
GET/actions/credit-corporate/instructions List governed corporate and treasury instructions actions:read Financial Actions Contract Try
POST/actions/credit-corporate/instructions Register a governed corporate instruction actions:create Financial Actions Contract Try
GET/actions/credit-corporate/obligations List governed credit and collection obligations actions:read Financial Actions Contract Try
POST/actions/credit-corporate/obligations Register a governed obligation source record actions:create Financial Actions Contract Try
POST/actions/credit-corporate/{uid}/checks Record a versioned credit, collection or corporate-action domain control actions:execute Financial Actions Contract Try
POST/actions/credit-corporate/{uid}/refresh Refresh source-record scope and invalidate stale approval when material evidence changed actions:execute Financial Actions Contract Try
GET/actions/execution-instructions List governed Payments & Treasury execution instructions actions:read Financial Actions Contract Try
GET/actions/execution-profiles List Payments & Treasury execution profiles and engaged kill switches actions:read Financial Actions Contract Try
GET/actions/intents List governed Financial Action envelopes for the active workspace actions:read Financial Actions Contract Try
POST/actions/intents Create a governed Financial Action envelope actions:create Financial Actions Contract Try
GET/actions/intents/{uid} Read one Financial Action envelope and current control-plane state actions:read Financial Actions Contract Try
GET/actions/intents/{uid}/approval-run Read the current Financial Action approval run and quorum progress actions:read Financial Actions Contract Try
GET/actions/intents/{uid}/evidence Read structured Financial Action control and evidence lineage actions:read Financial Actions Contract Try
POST/actions/intents/{uid}/execute Execute an authorized Financial Action through its separate execution authority actions:execute Financial Actions Contract Try
POST/actions/intents/{uid}/reconcile Reconcile an executed Financial Action against settlement evidence actions:read Financial Actions Contract Try
POST/actions/intents/{uid}/submit Submit a Financial Action for governed human approval actions:create Financial Actions Contract Try
GET/actions/investment-execution List investment order batches converged into governed Financial Actions investment:read Financial Actions Contract Try
POST/actions/investment-execution Adopt an investment order batch into the Financial Actions control plane investment:execute Financial Actions Contract Try
GET/actions/investment-execution/{uid} Read one governed investment execution convergence record investment:read Financial Actions Contract Try
POST/actions/investment-execution/{uid}/checks Record a versioned investment pre-trade control result investment:execute Financial Actions Contract Try
POST/actions/investment-execution/{uid}/confirmations Record broker trade-confirmation evidence without treating it as settlement investment:execute Financial Actions Contract Try
POST/actions/investment-execution/{uid}/custody Record independent custody settlement evidence and run canonical reconciliation investment:execute Financial Actions Contract Try
POST/actions/investment-execution/{uid}/refresh Refresh material investment-order scope and invalidate stale approval when needed investment:execute Financial Actions Contract Try
GET/actions/policies List scoped Financial Actions policies and conditional rules actions:read Financial Actions Contract Try
GET/actions/reconciliation List Financial Action settlement and reconciliation status actions:read Financial Actions Contract Try
GET/actions/reconciliation-exceptions List Financial Action reconciliation exceptions actions:read Financial Actions Contract Try
POST/actions/reconciliation-exceptions/{uid}/resolve Resolve a Financial Action reconciliation exception with retained evidence actions:execute Financial Actions Contract Try
GET/actions/risk-rules List active and historical dynamic Financial Action risk rules actions:read Financial Actions Contract Try
GET/companies List company-finance workspaces financial:analysis:read Financial Data & Planning Contract Try
GET/companies/{company} Read company finance profile and data coverage financial:analysis:read Financial Data & Planning Contract Try
GET/companies/{company}/analysis Read company analysis, financial resilience, DCF and linked forecast financial:analysis:read Financial Data & Planning Contract Try
GET/companies/{company}/financials Read normalized financial periods with source provenance financial:analysis:read Financial Data & Planning Contract Try
GET/companies/{company}/ratios Read deterministic financial ratios financial:analysis:read Financial Data & Planning Contract Try
POST/companies/{company}/scenarios Run deterministic company revenue and expense scenarios financial:analysis:run Financial Data & Planning Contract Try
POST/companies/{company}/valuations Run free-cash-flow DCF valuation financial:analysis:run Financial Data & Planning Contract Try
GET/data/datasets List datasets currently licensed for FinanceGPT API redistribution data:reference:read Financial Data & Planning Contract Try
GET/data/economics/series Search licence-governed economic series data:economics:read Financial Data & Planning Contract Try
GET/data/economics/series/{key} Get an economic series profile data:economics:read Financial Data & Planning Contract Try
GET/data/economics/series/{key}/observations Get economic observations and vintages data:economics:read Financial Data & Planning Contract Try
GET/data/instruments Search the canonical FinanceGPT securities master data:reference:read Financial Data & Planning Contract Try
GET/data/instruments/{uid} Get a canonical instrument, issuer, venue and identifiers data:reference:read Financial Data & Planning Contract Try
GET/data/instruments/{uid}/corporate-actions Get normalized corporate actions data:market:read Financial Data & Planning Contract Try
GET/data/instruments/{uid}/fundamentals Get standardized fundamental facts data:fundamentals:read Financial Data & Planning Contract Try
GET/data/instruments/{uid}/prices Get licence-governed normalized price history data:market:read Financial Data & Planning Contract Try
GET/data/tables Read governed FinanceGPT Data Studio tables data:tables:read Financial Data & Planning Contract Try
GET/data/tables/{uid} Read one governed Data Studio table and bounded preview data:tables:read Financial Data & Planning Contract Try
POST/data/tables/{uid}/ask Plan and execute a governed natural-language Data Studio operation data:tables:run Financial Data & Planning Contract Try
POST/data/tables/{uid}/operations Execute an allow-listed deterministic Data Studio operation pipeline data:tables:run Financial Data & Planning Contract Try
GET/financial/snapshots List normalized connected financial snapshots financial:read Financial Data & Planning Contract Try
GET/financial/transactions List normalized connected financial transactions financial:read Financial Data & Planning Contract Try
GET/planning/forecasts List governed FinanceGPT forecasts planning:read Financial Data & Planning Contract Try
POST/planning/forecasts Generate and persist a backtest-selected forecast planning:forecast:create Financial Data & Planning Contract Try
POST/lqm/evidence-packets/{packetUid}/verify Independently verify an LQM Evidence Packet and model evidence chain lqm:build:run LQM Builder Contract Try
POST/lqm/models/{uid}/evaluate Evaluate a sealed LQM checkpoint lqm:build:run LQM Builder Contract Try
POST/lqm/models/{uid}/promote Promote an evaluated LQM checkpoint into Quant Models lqm:promote:write LQM Builder Contract Try
GET/lqm/platform Read the governed LQM Builder platform foundation lqm:build:read LQM Builder Contract Try
GET/generative/models List approved FinanceGPT generative financial models generative:models:read Quant & Models Contract Try
POST/generative/paths Generate reproducible multi-period synthetic financial stress paths generative:inference Quant & Models Contract Try
POST/generative/scenarios Generate reproducible regime-conditioned financial scenarios generative:inference Quant & Models Contract Try
GET/quant/features/{key} Get one governed financial feature definition quant:features:read Quant & Models Contract Try
GET/agent-execution/workflows List published immutable Workflow Studio tools allowed for the signed external agent agent:execution:read Workflows Contract Try
GET/agent-execution/workflows/runs/{uid}/outcome Read measured workflow outcome evidence agent:execution:read Workflows Contract Try
POST/agent-execution/workflows/tools/{uid}/runs Invoke a published immutable production workflow agent:execution:invoke Workflows Contract Try
PUT/workflow-studio/qos/policy Update workspace weighted-fair dispatch and queue-age QoS policy workflow:manage Workflows Contract Try
POST/workflow-studio/versions/{uid}/validate Run a side-effect-free S16 validation campaign against an exact draft or testing version workflow:manage Workflows Contract Try