Aidelly Docs
REST API

Versioning and Deprecation

API version stability, deprecation signals, and sunset timelines.

The Aidelly Public API uses URL versioning. The current stable base URL is:

https://app.aidelly.ai/api/public/v1

Compatibility inside v1

Aidelly may add endpoints, optional response fields, response headers, and enum values without changing the version. Breaking changes move to a new versioned base path unless a security or legal requirement makes that unsafe.

Deprecation signals

A scheduled retirement receives at least 90 days of notice. Affected responses include:

  • Deprecation: an RFC 9745 Structured Field Date (for example, @1756684800)
  • Sunset: an RFC 8594 HTTP-date when the operation or version will stop working
  • Link: migration guidance with rel="deprecation"

The current v1 API is not deprecated. Active responses link to the public versioning and deprecation policy so automated clients can discover it before any retirement is scheduled.

Security, abuse, or legal emergencies may require a shorter notice window.

API Overview

Base URL, request format, response envelope, and versioning.

API Reference

Interactive reference for all Aidelly REST API endpoints.