Versioning policy
xTool exposes API versions in the URL path. The current version is v2; use it for new integrations. v1 is supported and will remain supported.
API versions
| Version | Path prefix | Status |
|---|---|---|
| v2 | /api/v2/ |
Current. Use for new integrations. |
| v1 | /api/v1/ |
Supported. Documents, invoice convert, PDF. Will remain supported. See Migration for moving to v2. |
See API Reference and Migration.
!!! important "Use v2" New integrations should use v2 endpoints. v1 is supported and will continue to be supported; new features are added to v2.
Stability and breaking changes
- Alpha (if used in future) — May be released for customer testing and feedback. Not stable; not production-ready; breaking changes are possible.
- Beta (if used in future) — May be released for customer testing and feedback. Not yet stable or production-ready; breaking changes are communicated in advance (e.g. in release notes).
Currently all v2 endpoints are under /api/v2/ with no alpha/beta path segments.
When we deprecate an endpoint or version, we announce it and provide a migration path. See Migration.