API changes and compatibility

2026-10-13: Reference accuracy and workflow guides

• Request examples respect exclusive numeric bounds and are checked against all real JSON request schemas. Important operations include curated synthetic payloads.
• Reference contracts show maintenance responses, mixed validator/application errors, and response headers. Multipart uploads use binary file fields; examples support JSON, text and empty 204 responses.
• Session documentation distinguishes locally resolved preferences from streaming-backend enforcement and explains retry states. These documentation changes do not change the current runtime adapter.
• Added realtime, billing, uploads, device, profile/security and staff workflow guides.

Compatibility conventions

The implemented major path is /v1. The OpenAPI document's info.version describes the reference contract; it is distinct from the monorepo release version and runtime SDK versions. No documented second Platform API major version or deprecation support period is currently implemented.

Accept additional object fields when reading responses and check the status/content type before consuming a body. Do not depend on field order. Required fields, enum meanings, nullability, accepted requests and error behaviors are part of an integration's contract and should be reviewed when updating a deployment. An enum change can affect exhaustive client switches even when the endpoint path stays the same.

Check this page and the operation reference when upgrading. Future intentional request/response breaking changes must be recorded here with affected operations, migration steps and the deployment/release that introduces them. Deprecated operations should carry OpenAPI metadata and a stated replacement rather than disappear silently. This is the documentation maintenance policy, not a guarantee of an unpublished support SLA.

See Conventions and Errors and pagination.