FinanceGPT Developer Quickstart

1 · Discover

Choose the smallest FinanceGPT primitive

Start from the capability you need, then open its API reference and required scope.

2 · Authenticate

Create and operate a sandbox application

Issue a least-privilege API key or OAuth service credential, then rotate or revoke it from the integrations console.

3 · Call

Make one governed API v2 request

Send a bearer credential, explicit JSON accept header and only the scopes required by the operation.

4 · Test

Validate the contract before scaling

Run bounded deterministic sandbox suites, inspect contract-change evidence and resolve readiness gaps before production.

5 · Observe

Inspect usage, latency and failures before scaling

Use workspace-scoped request evidence, generated client starters and SDK contract fingerprints to validate the integration.

6 · Deliver

Pin the contract and prepare production evidence

Use the compatibility policy, contract lock and CI checks to detect drift, then export evidence for human production review.

7 · Scale

Promote the application, not its authority

Production access, model promotion and Financial Actions remain separately entitled and governed.

8 · Operate

Carry evidence into support and certification

Open evidence-linked support cases and submit eligible integrations for explicit human certification review without exposing credentials or creating authority.

1. Choose a primitive and scope family

FinanceGPT capabilities are composable, but authority remains explicit.

Financial Data

data:* / financial:*

Data licensing and workspace permissions remain enforced.

Quant Models

quant:*

Quantitative outputs remain the numeric authority.

LQM Builder

lqm:*

LQM is quantitative only; it does not generate language.

QLMs

qlm:*

Language explains evidence; it does not become numeric authority.

Workflows

workflow:*

Human-review and control nodes remain enforceable at runtime.

Financial Actions

actions:*

API identity never creates transaction authority by itself.

Agents & MCP

agent:* / agents:mcp:*

Agent access remains tool-, scope- and policy-bounded.

Knowledge Intelligence

knowledge:*

Retrieval permissions and source evidence remain attached to results.

2. Create a sandbox application

API keys and OAuth service credentials are workspace-scoped and shown only at creation.

Create account Authentication guide

Select only the scopes required for the first operation. Sandbox credentials do not read production workspace data, and a credential never grants model promotion or Financial Actions authority by itself.

3. Make your first API v2 call

Start with the workspace profile to verify authentication and workspace resolution.

curl -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  https://financegpt.dev/api/v2/workspace

Expected boundary: a workspace-scoped response. Missing or invalid scopes fail closed rather than falling through to broader access.

4. Discover the platform contract

Use OpenAPI for endpoint schemas and the developer manifest for capability and governance discovery.

curl https://financegpt.dev/developers/manifest.json
curl https://financegpt.dev/developers/api-reference.json
curl https://financegpt.dev/developers/sdks/manifest.json
curl https://financegpt.dev/developers/changelog.json
curl https://financegpt.dev/developers/versioning.json
curl https://financegpt.dev/developers/ci/contract-lock.json
curl https://financegpt.dev/.well-known/financegpt-developer.json
curl https://financegpt.dev/developers/openapi.yaml

5. Generate, test, integrate and observe

Move an exact API Reference operation into a generated client starter, run deterministic sandbox contract tests, then inspect workspace-scoped latency and failures before production.

SDK lifecycle API changes Versioning CI

Generate, integrate and observe with generated client starters that carry the current OpenAPI fingerprint and environment-variable credential placeholders. Sandbox test suites reuse deterministic Developer Catalog fixtures, while observability and readiness expose metadata and evidence without raw credentials or request/response bodies.

Production is a separate decision

Move to production only after the application has an eligible developer entitlement and the required workspace permissions. Model promotion, QLM composition, external-agent execution and Financial Actions each retain their own governance controls.

Review API plans

Operate with evidence

When an integration reaches production review, carry the same contract and runtime evidence into support and certification. Do not send API keys or OAuth secrets with support requests.

Support policy Certification standard Developer programme