Skip to main content
This page records changes to the Onsomble API contract. The current version is v1, served from https://api.onsomble.ai/v1.

Versioning policy

The major version appears in the URL. Additive changes do not create a new major version. This includes new optional response fields and new endpoints. A breaking change creates a new major version and an entry on this page. Breaking changes include removing or renaming an endpoint, removing or renaming a response field, changing a field’s meaning or type, changing authentication behaviour, or changing a stable error code.

v1

Initial API

v1 provides read access to Clients, Sites, Scans, and discoverability reports. It can also start a Scan for an existing Site. Report filters and responses identify AI platforms with stable IDs such as chatgpt_app and state whether Onsomble collected the answer from the web or an API. Future additive v1 changes will be documented here without changing the /v1 URL. A breaking change will appear as a new major-version section before the new version is released.