Getting Started
Last verified: 2026-06-20 (Task #388 — multi-feature portal restructure).
The Platform API groups the cross-cutting developer-account endpoints that aren't tied to a single product surface: webhooks (subscribe to signed events and inspect deliveries) and usage (read your plan, quota, and remaining capacity). They share the same response envelope, error format, auth scheme, and rate-limit headers as every other feature in the developer platform.
Base URL
| Environment | URL |
|---|---|
| Production | https://api.travelmode.ai |
| Self-hosted Replit deployment | https://your-app-domain.replit.app |
The /v1/ prefix is part of the path.
API keys
Platform endpoints authenticate with the same developer API keys used for the product features. Send the key on every request:
curl -s "https://api.travelmode.ai/v1/usage" \
-H "Authorization: Bearer tm_weather_..."
GET /v1/usage is readable by any valid key. Webhook management requires
the weather:webhooks scope — see
authentication.md.
The two endpoint families
- Webhooks — register an HTTPS endpoint, choose the events you care
about, verify signed deliveries, and inspect delivery attempts. Start
with
webhooks.md. - Usage — poll your current-period plan limits and usage without
burning quota. Start with
usage.md.
Where next
- The full machine-readable contract is in
openapi.yaml. - Signing, retries, and auto-disable behavior live in
webhooks.md.