Skip to main content

Changelog

This page lists notable changes to the Truedy Public API and its documentation. Format is based on Keep a Changelog.

[Unreleased]

  • (Add new changes here before release.)

2026-03

Documentation and API behavior

  • Quickstart: API key creation is documented as Dashboard-only; removed references to a non-existent Public API endpoint for creating keys.
  • 402 Payment Required: Documented in Authentication and Error Handling. Described payment_required code, redirect_url, and reason (e.g. trial_not_started, trial_expired, insufficient_credits).
  • Error responses: Request validation (422) now returns the same Truedy envelope (error + meta) as other errors. Rate limit (429) responses now include meta.request_id and meta.ts.
  • Rate limits: Documentation updated to match implementation: per-minute only (default 100), no per-hour/per-day tiers, no rate limit headers; use 429 body details.limit and details.reset_at.
  • OpenAPI: Added 402 to standard response codes. Examples fixed: system_prompt (not instructions), meta.ts and meta.request_id (not timestamp/count), snake_case error codes (validation_error, unauthorized, etc.).
  • Pagination: Clarified offset-based vs page-based pagination; contacts list documented as page-based (page, limit, total, pages).
  • Webhooks: Documented payload shape, X-Truedy-Signature / X-Truedy-Timestamp, HMAC-SHA256 verification, event_id/dedupe, and retry behavior. Configuration stated as Dashboard-only.
  • Versioning: Added versioning and changelog pages.