Changelog
API versioning, deprecation policy, and release notes.
Versioning
The path is the version. https://www.citeflow.io/api/v1 is stable; we
will not change request/response shapes within v1 in breaking ways.
Breaking changes mint v2.
| Change type | Versioned? |
|---|---|
| New field added to a response | No (additive) |
| New optional request field | No (additive) |
| New endpoint | No (additive) |
| New webhook event type | No (additive) |
| New error code | No (additive) |
| Existing field renamed/removed | Yes — v2 |
| Existing field type changed | Yes — v2 |
| Webhook signature scheme changed | Yes — v2 |
Deprecated endpoints stay live for at least 180 days after the
deprecation announcement, double-served alongside v2. Email notice
goes to every workspace contact.
Releases
v1.0 — 2026-05-27
Initial public release.
- 6 endpoints:
POST /audit,GET /audit/{id},POST /audit/{id}:cancelGET /balancePOST /billing/topupPOST /webhooks/deliveries/{id}/replay
- 4 webhook event types:
audit.completed,audit.failed,audit.cancelled,balance.low
- 3 tier packages: Starter $49, Growth $199, Scale $499 (Enterprise via manual invoice).
- HMAC-SHA256 webhook signatures (
v1=base64(...)). - Idempotency-Key on
POST /audit(24h window). - Sliding-window rate limits per (api_key, endpoint).
- Auto-refunds via failure matrix (50% on engine failure, 0% on partner input).
- Live mode only — no sandbox. Use the dashboard onboarding test credits for first integration.
- SDKs v0.1.0:
@citeflow/sdkon npm (Node 18+)citeflow-pythonon PyPI (Python 3.9+)
Subscribe to changes
- Watch docs.citeflow.io/changelog — this page is the canonical record.
- Workspace contact email receives deprecation notices.
- Major releases announced via the CiteFlow status page + partner
Slack (request invite via
partners@citeflow.io).