Skip to main content

API PLATFORM

Changelog & versioning

How the NUVC API is versioned, what changed and when, and what your usage will cost.

Versioning policy

v3 is the current, stable version. All new integrations should target /api/v3/*. Earlier versions (v1, v2) are legacy surfaces retained for existing internal clients and are not available for new integrations.

  • No breaking changes within a version. Within v3 we only make additive changes — new endpoints, new optional parameters, new response fields. Build clients that tolerate unknown fields.
  • Deprecations are announced, headed, and windowed. A deprecated path keeps working through its sunset window and is stamped with Deprecation: true and Sunset response headers, alongside an entry on this page. Alert on those headers in your client logs.
  • Breaking changes ship as a new major version with a migration guide and an overlap period where both versions are served.

Cost estimator

Pricing is pay-as-you-go: one score credit per metered call, in packs of 50 for $99 AUD. Estimate your monthly spend from expected usage.

One credit = one metered call, from any channel (REST API, MCP, or web). Non-metered endpoints — reads, status polls, key management, webhooks — are free.

Credits / month35
Starter packs (50 credits @ $99)1
Estimated monthly cost$99 AUD

≈ $2.83 per call at this volume. 15 unused credits roll over — credits never expire. Your first 2 calls are free on signup.

Changelog

ADDED

Developer experience: rate-limit headers, SDK examples, explorer

  • X-RateLimit-Reset joins X-RateLimit-Limit / X-RateLimit-Remaining on /api/v3/ai/* responses — the standard trio is now complete on the monthly quota path.
  • Runnable SDK examples shipped for Python (nuvc-python/examples) and TypeScript (nuvc-ts/examples): quickstart scoring, investor matching, and batch flows.
  • Interactive API explorer (try-it reference over the OpenAPI spec) available at /api-platform/docs/explorer — progressive rollout.
ADDED

Webhook signing secrets

  • Webhook endpoints carry a per-endpoint signing secret; verify the signature header on every delivery before trusting the payload.
  • Delivery retries use exponential backoff (1 min → 5 min → 30 min → 2 h → 8 h, five attempts); endpoints auto-disable after 10 consecutive failures.
CHANGED

Pay-as-you-go score credits

  • Tiered API subscriptions replaced by pay-as-you-go score credits: one credit per metered call (nuvc_score, nuvc_screen_fund, nuvc_match_investors).
  • One balance, three channels — the same credits are spent from the REST API, the MCP server (npm install nuvc-mcp), and the web app.
  • New accounts start with 2 free credits; credits never expire.
DEPRECATED

Investor routes split: /api/v3/vc and /api/v3/fo

  • The combined /api/v3/investors/* namespace is deprecated in favour of the product-specific /api/v3/vc/* (emerging VC) and /api/v3/fo/* (family office) namespaces.
  • Deprecated paths keep working through the sunset window and are stamped with Deprecation: true and Sunset response headers — watch for them in your client logs.

Questions about a change or a deprecation window? Reach us via the developer dashboard — we answer before the sunset date, not after.