API Reference

Recommendation API

A minimal REST API for submitting client requirements and retrieving ranked shortlists. Designed for institutional integration — drop into advisory workflows, compliance systems, or white-label product flows.

Try the recommendation engine

Authentication

The MVP API runs without authentication in the current prototype. Production access uses API key authentication — institution-scoped keys passed as a header.

http

Authorization: Bearer YOUR_API_KEY

API key access is available on request for pilot partners. Request access →

Base URL

url

https://api.qavcm.com/v1

Prototype runs locally at http://localhost:3000

Typical integration flow

POST requirements

/api/recommendations

GET shortlist

…/{id}

GET compare

…/{id}/compare

GET export

?format=json

Endpoints

RecommendationRequest fields

co2VolumeTonsnumberrequiredVolume to offset in tonnes CO₂e

standardsstring[]optionalVCS, GS, ACR, CAR, REGEN — empty = all

projectTypesstring[]optionalREDD, NBS, RENEWABLES, COOKSTOVES, BLUE_CARBON, SOIL_CARBON, AVOIDANCE, CDR — empty = all

regionsstring[]optionalEurope, Latin America, Sub-Saharan Africa, Southeast Asia, South Asia, North America, Global

vintageMinnumberoptionalEarliest acceptable vintage year (e.g. 2021)

vintageMaxnumberoptionalLatest acceptable vintage year

budgetModestringrequiredlowest-cost | balanced | quality-first

exclusionsstring[]optionalProject IDs or name substrings to exclude

maxResultsnumberoptionalMax options to return — default 5, max 20

Ready to integrate?

Try the recommendation engine in the UI first, then use the same logic via API.

Try the engine