# Read me

> Orchestrator API specification notes, including the OpenAPI 3.0 update and the deprecation timeline for the previous Swagger 2.0 specification.

:::important
The Orchestrator default API specification is compliant with OpenAPI 3.0. The previous specification (V20, based on Swagger 2.0) is deprecated and remains available for a limited time for backward compatibility, see [Deprecation timeline](#deprecation-timeline) below for exact dates. After you migrate to the new specification, all regenerated API clients based on the new JSON definition will have to be readjusted.
:::

If you plan on integrating our APIs with your client, you need to be aware of the possible updates and changes that may happen to the API specification, JSON schemas, or API endpoints.

The following list provides information and recommendations regarding API specification changes. If you have further questions, [contact our support team](https://customerportal.uipath.com/support/add-case).

## Deprecation timeline

| Delivery model | Deprecated | Removed |
|---|---|---|
| Automation Cloud | August 2026 | September 2026 |
| Automation Suite | 2.2610 release | 2.2610 release |

## Information and recommendations about Swagger changes

1. The JSON API description represented in the Swagger JSON document can change at any time. However, it will describe the same underlying API, to ensure backwards compatibility.
2. The Swagger interface and the corresponding JSON are generated based on the current endpoints, and we always publish the latest version. To ensure backwards compatibility, we support the same request structure.
3. As an alternative to runtime generated API clients, use fixed or compile time API clients. Doing so reduces dependency and prevents major automation updates in case the API or Swagger definition changes.
4. Items marked as deprecated are available for a limited time, after which the items are removed from the Swagger definition and JSON API.
5. Whenever certain APIs changes internally, a new Swagger API version is published. The API version number does not influence the usage of the client API. We do not recommend relying on API versioning.

## API examples

The examples provided in the existing Orchestrator reference document describe complex scenarios and endpoints.

You can see all available APIs in the Swagger JSON, which contains the latest updates.