Developer Changelog with Code

API Changelog

Developer Changelog

Breaking changes, new endpoints, and migration guides.

v3.0.0Breaking

March 2025

New Authentication Model

We have replaced API key authentication with short-lived tokens and refresh flows. All existing API keys will continue to work until June 2025, but we strongly recommend migrating to the new model for improved security and granular scoping.

Migration example

// Before (v2.x)
const client = createClient({
  apiKey: "sk_live_..."
});

// After (v3.0)
const client = createClient({
  token: await getToken({
    clientId: "cl_...",
    clientSecret: "cs_...",
    scopes: ["read", "write"]
  })
});
  • API keys deprecated in favor of OAuth2 tokens
  • New /auth/token endpoint for token exchange
  • Scoped permissions per token
  • Refresh token rotation with 7-day expiry
v2.12.0Feature

February 2025

Batch Operations Endpoint

Process up to 1,000 operations in a single request with transaction-safe batch endpoints. Supports creates, updates, and deletes with atomic rollback on failure.

Usage

const result = await client.batch({
  operations: [
    { method: "POST", path: "/users", body: { name: "Alice" } },
    { method: "PATCH", path: "/users/42", body: { role: "admin" } },
    { method: "DELETE", path: "/users/17" }
  ],
  atomic: true
});

// result.results: [{ status: 201 }, { status: 200 }, { status: 204 }]
  • New POST /batch endpoint
  • Atomic mode with full rollback on error
  • Up to 1,000 operations per request
  • Mixed HTTP methods in a single batch
v2.11.0Feature

January 2025

Server-Sent Events for Resources

Subscribe to real-time changes on any resource collection using Server-Sent Events. No more polling — get instant updates pushed to your client as they happen.

Example

const stream = client.subscribe("/users", {
  events: ["created", "updated", "deleted"]
});

stream.on("created", (user) => {
  console.log("New user:", user.name);
});

stream.on("error", (err) => {
  console.error("Stream error:", err.message);
});
  • SSE support on all resource endpoints
  • Event filtering by type
  • Automatic reconnection with last-event-id
  • Backpressure handling for high-throughput streams
About this block

Developer Changelog with CodePRO

Technical changelog with code blocks showing API changes, migration examples, and usage snippets alongside release notes.

More Changelog blocks

View all Changelog
PRO

changelog20

Roadmap Status Changelog

Hybrid roadmap and changelog with shipped, in-progress, and planned items. Includes status dots, tags, and optional feature images.

PRO

changelog24

Callout Highlight Changelog

Release feed with prominent callout blocks highlighting the most impactful change per release.

PRO

changelog12

Large Version Changelog

Poster-style changelog with oversized version numbers as visual anchors, followed by date, heading, and description text.

PRO

changelog6

Minimal Text Changelog

Ultra-minimal text-only changelog with version headers and dash-prefixed change lists. No badges, no cards, just clean typography.

PRO

changelog8

Featured Release Changelog

Latest release highlighted in a featured card with full details, followed by a compact list of previous releases.

PRO

changelog5

Milestone Changelog Timeline

Timeline-style changelog with version badges, dates, and color-coded change types. Ideal for release notes and version history.