Onboarding

1. Sign in

Use the same account you use for the consumer product. From the dashboard, request a TEOScore-only key under API keys.

2. Issue a key

POST /v1/keys
{
  "name": "TEOScore prod",
  "scopes": ["usage.read", "flights.search"]
}

Scored search (/v1/search) requires the flights.search scope — the same scope as the raw /v1/flights/search endpoint. If instead you only score flight options you already have (/v1/score/score), issue a key with score.write rather than flights.search. The SDK and gateway respect scope per route.

3. First call

Call POST /v1/search — the orchestrated endpoint that searches flights and scores them with TEOScore in one call, so you get a score on every result. (For raw flight data without scores, call /v1/flights/search instead; see the Search API reference for the full request and response schema.)

curl -X POST https://teofetch-api.onrender.com/v1/search \
  -H "Authorization: Bearer tfp_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "origin": "JFK",
    "destination": "LHR",
    "departureDate": "2026-08-15",
    "returnDate": "2026-08-22",
    "passengers": { "adults": 1 },
    "cabinClass": "business",
    "searchMode": "all"
  }'

The response includes a providerOptions array (the flights) and a teoscoreOptions array (the score, rank, and category breakdown per option).

4. Watch your usage

Set a budget cap at 80% of your monthly quota. The dashboard shows live usage; alerts fire at 80% and 95%. See the production checklist for the full set of pre-launch checks.

5. Go live

When you are ready, see go-live for the cutover checklist.