Skip to main content

Concepts

Versions and changelog

How the Browlix API changes, the 90-day notice for breaking changes, the Deprecation and Sunset headers, client compatibility and every schema revision.

View as Markdown

The API has one version in the URL, /api/v1, and a schema revision that changes with every published contract change. The discovery document (GET /api/v1) and every MCP tool carry the current revision.

What can change without notice

  • A new operation, a new optional input, a new reply field, a new enum value, a new error details key, a new MCP protocol revision.
  • Clients must ignore fields they do not know and treat an unknown enum value as "other". The SDK and the MCP output schemas are written that way.

Breaking changes

Removing or renaming an operation or a field, changing a type, or changing what a value means is a breaking change.

  1. It is announced in this changelog at least 90 days before it takes effect, with the replacement when there is one.
  2. From the announcement on, every reply of the affected operation — success or error — carries Deprecation (RFC 9745, the announcement time), Sunset (RFC 8594, the cutoff) and Link: <…/api-changelog>; rel="deprecation".
  3. The OpenAPI document marks the operation deprecated: true with x-sunset; the MCP tool description starts with the cutoff date and its _meta carries browlix/deprecated.
  4. The discovery document lists every pending deprecation under versioning.deprecations.

Check for the Sunset header in your logs or tests — it is the earliest signal.

Compatibility

  • TypeScript SDK: 0.5.0 and later work against the current schema revision (each release was run against it). 0.6.0+ for NodeNext/ESM types, 0.8.0+ for acquireSession, 0.9.0+ for typed replies.
  • Machines update their worker themselves; a feature that needs a newer worker is reported per machine as features.*.min_worker by devices.capabilities.
  • Breaking changes are announced at least 90 days ahead.

Changelog

RevisionDateChangeOperations
2026-10-27.p9-organize2026-10-27added: Rename and delete tags and groups (until now only in the web app). Reported by an AI agent through feedback (HQA-33).tags.update, tags.delete, groups.update, groups.delete
2026-10-27.dv11-dv122026-10-27added: Typed replies: OpenAPI response schemas, MCP outputSchema and SDK reply types for workspace, profiles, sessions, bindings, devices and feedback. MCP protocol revision 2026-07-28 (stateless, server/discover) served next to 2025-11-25, 2025-06-18 and 2025-03-26. Deprecation/Sunset headers and client compatibility in the discovery document.—
2026-10-27.p9-app-leases2026-10-27added: App account bindings, app holds on sessions (acquire, renew, detach with fencing generations, keep-warm), the session event cursor and per-machine capabilities.devices.capabilities, bindings.list, bindings.create, bindings.update, bindings.delete, sessions.acquire, sessions.renew, sessions.detach, sessions.events
2026-10-27.p16-session-recover2026-10-27added: Settle a session whose end is uncertain from the API (previously only in the web app).sessions.recover
2026-10-27.p9-feedback2026-10-27added: Feedback tickets for people and AI agents: submit, list, read and comment.feedback.submit, feedback.list, feedback.get, feedback.comment
2026-10-26.p10-automation2026-10-26added: Automation: flows, runs and their targets, tasks, schedules and approvals.flows.list, flows.get, flows.run, runs.list, runs.get, runs.stop, runs.pause, runs.retry, run_targets.get, run_targets.resolve, tasks.list, tasks.run, schedules.list, schedules.set_state, approvals.list, approvals.decide
2026-10-26.p5-sync2026-10-26added: Profile data sync: overview, per-profile status, restore, release and data key rotation.sync.overview, profiles.sync.get, profiles.sync.restore, profiles.sync.release, data_keys.rotate
2026-10-26.p8-adspower2026-10-26added: Machines report the state of their AdsPower-compatible Local API.—
2026-10-26.p8-webhooks2026-10-26added: Signed webhooks (Standard Webhooks): endpoints, secret rotation, test events, delivery log and redelivery.webhooks.list, webhooks.create, webhooks.update, webhooks.rotate_secret, webhooks.delete, webhooks.test, webhooks.deliveries, webhooks.redeliver
2026-10-26.p8-mcp2026-10-26added: MCP server on the same operations, and the OpenAPI document.openapi.get
2026-10-25.p4-usage2026-10-25added: Workspace usage and limits; sessions.start answers QUOTA_EXCEEDED at the concurrent-session limit.usage.get
2026-10-25.p4-prefs2026-10-25added: Versioned browser preference templates.preference_templates.list, preference_templates.get, preference_templates.create, preference_templates.publish, preference_templates.update, preference_templates.upgrade_profiles
2026-10-25.p42026-10-25added: Machines and browser sessions: start, stop and short-lived attach tickets.devices.list, sessions.list, sessions.get, sessions.start, sessions.stop, sessions.attach
2026-10-25.p22026-10-25added: Profiles, groups, tags and proxies.profiles.list, profiles.get, profiles.create, profiles.update, profiles.trash, profiles.restore, groups.list, groups.create, tags.list, tags.create, proxies.list, proxies.get, proxies.create, proxies.update, proxies.delete
2026-10-25.p12026-10-25added: API v1: workspace, members, invites, audit events and command receipts.discovery.get, workspace.get, workspace.rename, members.list, invites.create, audit.list, receipts.get

Deprecated. No operation is currently deprecated.