All notable changes to the platform and API are documented here. The format follows Keep a Changelog. Versions follow Semantic Versioning.
Changes that are in progress but not yet shipped:
metadata field on resources — attach up to 20 custom key-value pairs to any resource for your own internal reference.X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset on every request, not just when limits are exceeded.GET /v1/resources returned incorrect hasMore values when filtering by status.archived status — resources can now be archived instead of deleted. Archived resources are excluded from list responses by default but can be retrieved with ?status=archived.description field on resources now supports up to 2,000 characters (previously 500).GET /v1/resources?offset={n} — use cursor-based pagination instead. Offset support will be removed in v2.0.X-Signature header on retried requests.PATCH /v1/resources/{id} returning 500 when metadata was set to an empty object.The platform is now generally available.
What's included in v1.0:
POST endpointsReplace any calls using ?offset= with the cursor-based pattern:
// Before (deprecated)
const page1 = await client.resources.list({ limit: 20, offset: 0 })
const page2 = await client.resources.list({ limit: 20, offset: 20 })
// After
let cursor: string | null = null
do {
const response = await client.resources.list({ limit: 20, cursor })
process(response.data)
cursor = response.nextCursor
} while (response.hasMore)Offset pagination will continue to work until v2.0, at which point requests using offset will return a 400 error.