Skip to content

Versioning

The PhotoPick API is versioned in the URL path. The current stable version is v1.

https://api.photopick.cz/api/v1/...

Within a major version (/api/v1/*), PhotoPick will not make breaking changes. Specifically:

  • Endpoints will not be removed.
  • Response field types will not change.
  • Required request fields will not be added.
  • Existing response fields will not be renamed.

Non-breaking additions are allowed at any time:

  • New optional request fields.
  • New response fields (clients should ignore unknown fields).
  • New endpoints.
  • New scopes (existing keys continue to work; new endpoints may require a new scope).
  • New error codes (so handle unknown codes gracefully — log and surface message).

When a major version is superseded, the old version enters a 6-month deprecation window:

  1. Announcement — release notes flag the new version and the deprecation date.
  2. Sunset header — every response from the deprecated version carries an RFC 8594 Sunset header pointing at the end date.
  3. End of life — after the window, the deprecated version returns 410 Gone.
HTTP/1.1 200 OK
Sunset: Sat, 31 Dec 2026 23:59:59 GMT
Deprecation: true
Link: <https://developer.photopick.net/reference/v2/>; rel="successor-version"

When v2 ships, this site will host both references side by side under /reference/v1/ and /reference/v2/, plus a migration guide enumerating every difference.

The OpenAPI document at /api/v1/openapi.yaml is the source of truth for what v1 currently exposes. This docs site rebuilds from that document on every deploy.