Realm Docs
  • Welcome
  • Getting Started
    • Quickstart
  • Basics
    • Image Gen
    • Video Generation
    • Authentication
    • Create or Edit Model
    • MarketPlace
    • Users
  • Advanced
    • Idempotency
  • Rate Limiting
  • Security
  • Versions
  • Webhooks
Powered by GitBook
On this page
  • Advanced: API Versioning
  • Versioning Scheme
  • Backward Compatibility
  • Breaking Changes
  • Deprecation Policy
  • Staying Updated

Versions

Advanced: API Versioning

REALM AI is committed to providing a stable platform, but APIs evolve over time to introduce new features, improve performance, or address issues. We use API versioning to manage these changes gracefully.

Versioning Scheme

Our API uses URL path versioning. The current stable version is v1, accessible via the base URL:

https://api.realm.ai/v1/...

Backward Compatibility

We strive to maintain backward compatibility within a major version (v1). This means:

  • Additive Changes: We may add new API endpoints, optional request parameters, or new properties to existing API responses without bumping the version.

  • Non-Breaking Changes: Existing endpoints and required parameters will generally remain stable within v1.

Your integration should be tolerant of new, unexpected fields appearing in API responses.

Breaking Changes

Changes that are not backward-compatible (e.g., removing an endpoint, renaming a required field, changing authentication methods) will result in a new major API version (e.g., v2).

https://api.realm.ai/v2/...

Deprecation Policy

When a new major API version (v2) is introduced:

  1. Announcement: We will announce the new version and the deprecation timeline for the older version (v1) via developer email lists, platform notifications, and these documentation pages.

  2. Deprecation Period: The older version (v1) will remain available and supported for a minimum period (e.g., 6-12 months) after the new version (v2) is released.

  3. Migration: During the deprecation period, developers are expected to migrate their applications to the new API version.

  4. Sunset: After the deprecation period ends, the older API version (v1) may be decommissioned and will no longer be available.

Staying Updated

  • Monitor the REALM AI developer blog/changelog (link to be provided).

  • Ensure your developer contact email address is up-to-date in your account settings.

  • Periodically review this documentation for updates.

(This policy ensures developers have ample time to adapt to API changes while allowing REALM AI to innovate.)

PreviousSecurityNextWebhooks

Last updated 1 month ago