Skip to main content

Versioning and changes

Beta​

The API is in beta. Until it's generally available, anything documented here can change, including in ways that aren't backward compatible. See Release status.

Versions​

REST paths include a major version: /public/v1/. Which changes FieldTask may make within a version hasn't been decided yet, so build integrations that tolerate additions:

  • ignore response fields you don't use;
  • handle unknown enum values, event types and error codes without failing (a job status of unknown is already part of the contract);
  • don't rely on the order of fields in JSON.

This site documents contract 2026-11-03-review.2. Each published contract has its own version identifier, and the changelog lists what changed.

Changes and notice​

Not decided yet

The compatibility policy, the notice period for breaking changes, and how changes are announced haven't been decided.