Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Azure AI Projects REST API lets you work with AI projects, the central resource that brings together models, data, tools, and telemetry in Azure AI Foundry. Using familiar HTTP verbs you can create a project, configure secure connections to other Azure services, and retrieve ready-to-use endpoints for inferencing, agents, evaluation, and more. Because every service you attach lives behind a single project connection string, applications only need to know one credential and one base URL to reach everything they need.
Versioning
Azure AI Foundry API provides two types of versioning:
- Evolving Version: These versions follow the format v# (e.g., v1, v2, v3). As the name suggests, evolving versions incorporate non-breaking changes to the contract, such as the addition of optional parameters to requests or new properties to responses. Clients using these versions should be designed to handle additive changes.
- Pinned Version: These are date-based versions that do not include contract changes. The following table illustrates how these versions work.
| Timeline | Evolving Version | Pinned Version | Notes |
|---|---|---|---|
| 25-May | v1 | 5/1/2025 | Customers who do not want any changes to the contract can use the date-based version. Customers who want all the latest non-breaking changes can use v1. |
| Non-Breaking Change 1 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 1. |
| Non-Breaking Change 2 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 2. |
| Non-Breaking Change 3 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 3. |
| 3-Month Interval | v1 | 8/1/2025 | Customers who need non-breaking changes 1, 2, and 3 with no further changes can use the 2025-08-01 version. |
| Non-Breaking Change 4 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 4. |
| Non-Breaking Change 5 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 5. |
| Non-Breaking Change 6 | v1 | N/A | Customers using v1 will automatically be able to use non-breaking change 6. |
| 3-Month Interval | v1 | 11/1/2025 | Customers who need non-breaking changes 4, 5, and 6 with no further changes can use the 2025-11-01 version. |
| (Hypothetical) Breaking Change in Jan 2025 | v2 | 1/1/2026 | Since there is a breaking change, customers will need to switch to v2 or the 2026-01-01 version to access the changes. |
| Deprecation Announcement | All previous versions will be marked as deprecated: * 2025-05-01 * 2025-08-01 * 2025-11-01 * v1 They will be retired after one year. |
||
| Non-Breaking Change 7 | v2 | N/A | Customers using v2 will automatically be able to use non-breaking change 7. |
| Non-Breaking Change 8 | v2 | N/A | Customers using v2 will automatically be able to use non-breaking change 8. |
| Non-Breaking Change 9 | v2 | N/A | Customers using v2 will automatically be able to use non-breaking change 9. |
| 3-Month Interval | v2 | 3/1/2026 | Customers who need non-breaking changes 7, 8, and 9 with no further changes can use the 2026-03-01 version. |
Non breaking changes
Non breaking changes are defined as follows:
- Adding new resources (URLs) to the REST API and SDKs
- Adding new optional API parameters
- Adding new properties to JSON response objects or event data
- Changing the order of properties in a JSON response object
- Changing the length or format of opaque strings, like resource identifiers and UUIDs
- Adding new event types (in either streaming or the Realtime API)