API Reference
API Changelog
All notable changes to the Snapedit API are documented here. This project follows Semantic Versioning.
Deprecation Policy
Breaking changes are announced at least 90 days before removal via email and this changelog. Deprecated endpoints will include Deprecation: true and Sunset: <date> response headers. Legacy paths (e.g. /api/object_removal/v5/*) remain supported alongside new /v1/* paths.
v1.0.3
- AddedAdded input validation for supported image formats, image resolution, video formats, and video duration.
- ChangedUpdated Enhance Video `zoom_factor` documentation from `HD` to `FHD`
- AddedAdded Remove Logo Video resolution validation: input videos must be Full HD or lower, up to 1920 px on the longest side; larger videos return a `400` error.
- ChangedUpdated Remove Logo image mode parameter from `predict_mode` (`3.0`, `4.0`) to `erase_mode` (`lite`, `default`).
v1.0.2
- AddedAdded the Generate Background API at `POST /v1/images/generates-background`.
- AddedAdded `output_type` support for Remove Background and Remove Background Graphic APIs.
v1.0.1
- AddedAdded new APIs: Remove Background Graphics, Remove Reflection, and Clean Mirror.
- AddedAdded `hd_mode` parameter support for the Virtual Try-On API.
- ChangedUpdated credit values across all endpoints.
- ChangedDocumented detailed supported `lang` values for the Detect Objects API.
v1.0.0
- AddedInitial public API release with 25 image processing endpoints.
- AddedClean REST paths under `/v1/images/*` for all endpoints.
- AddedRate limiting: 60 requests/minute per API key with `x-ratelimit-*` response headers.
- AddedHealth check endpoint at `GET /v1/health`.
- AddedInteractive API Playground (Swagger UI) at `/docs/playground`.
- AddedQuickstart guide in API docs.