Skip to main content

Changelog

All notable changes to the Flow API are documented here. This changelog follows Keep a Changelog conventions.

For breaking changes, we provide deprecation notices and migration guides.


[1.0.0] - 2024-01-01

Added

  • Public API v1 - Initial stable release of the public API at api.flowsocial.app/v1
  • API Key Authentication - Secure API key-based authentication with Bearer tokens
  • Posts API - Create, read, update, delete posts with batch operations
  • Channels API - Manage content channels
  • Connections API - OAuth flows for Twitter, LinkedIn, Meta, and TikTok
  • Webhooks API - Real-time event notifications with signature verification
  • Media API - Upload and manage media attachments
  • Usage API - Monitor API usage and limits
  • Rate Limiting - Fair usage limits with X-RateLimit-* headers
  • Idempotency - Support for Idempotency-Key header on POST requests
  • TypeScript SDK - Official @flowdev/sdk package
  • Python SDK - Official flow-sdk package
  • Go SDK - Official github.com/flowdev/go-sdk package

Changed

  • Response format standardized to {"data": ..., "meta": {...}} envelope
  • Pagination uses page and per_page parameters

Deprecated

  • Internal /api/* endpoints - migrate to /v1/* endpoints

Upcoming

Planned Features

  • Permissions-scoped API keys
  • Bulk media upload
  • Additional webhook events

Beta Features (Not Yet Stable)

The following features are available but not yet covered by our stability guarantee:

  • Channel templates and seeds
  • Channel analytics
  • AI-optimized content
  • Channel sharing and collaboration

See API Stability for details on our stability classifications.


Versioning Policy

  • Major versions (1.0 → 2.0): May include breaking changes. Announced 6+ months in advance.
  • Minor versions (1.0 → 1.1): New features, backward compatible.
  • Patch versions (1.0.0 → 1.0.1): Bug fixes, backward compatible.

We aim to avoid breaking changes. When necessary, we provide:

  1. Deprecation notice in changelog
  2. Migration guide
  3. Minimum 6-month deprecation period
  4. Clear communication via email and docs

Subscribe to Updates