AITRIOS | Edge AI Sensing - Console Developer Edition Release Note
April 7, 2025
Console REST API v2: New API Released
We are pleased to announce the release of our all-new Console REST API v2. This features a new communication interface and requires dedicated versions of Console v2, Edge Application SDK, and sample applications. These are also released today to provide enhanced performance and functionality.
⚠️ NOTE: Once you upgrade from v1 to v2, you CANNOT downgrade back to v1.
Before migrating to Console REST API V2, please review the following documentation:
Continue Using Console REST API v1
Migrating to the new API is still optional at this time. The existing Console REST API (Console REST API v1) and Console v1, edge device firmware, Edge Application SDK, and edge applications that support Console REST API V1 are still available.
To access Console REST API v1:
- Browser Access: Select V1 in the top-right corner (this is set as default)
- API Access: Continue using the existing endpoint for API v1 functionality
Console REST API V2 support status
Refer to the compatibility table
Console REST API V1 / Console V1 | Console REST API V2 / Console V2 | Remarks | |
|---|---|---|---|
Endpoints | Console REST API V1 / Console V1 Console REST API V1 Endpoint | Console REST API V2 / Console V2 Console REST API V2 Endpoint | Remarks |
Edge Firmware (Device Firmware) | Console REST API V1 / Console V1 Console REST API V1 Firmware | Console REST API V2 / Console V2 Console REST API V2 Firmware | Remarks Not compatible |
Edge Applications | Console REST API V1 / Console V1 Console REST API V1 Applications | Console REST API V2 / Console V2 Console REST API V2 Applications | Remarks Not compatible |
Parameters | Console REST API V1 / Console V1 Command Parameters | Console REST API V2 / Console V2 Edge Application Interface JSON / Edge Device Interface JSON | Remarks Not compatible |
TFLite | Console REST API V1 / Console V1 Support ended | Console REST API V2 / Console V2 Not supported | Remarks Support for TFLite has ended |
Keras/ONNX/PackerOut.zip | Console REST API V1 / Console V1 Supported | Console REST API V2 / Console V2 Supported | Remarks |
Registered AI Models | Console REST API V1 / Console V1 Common | Console REST API V2 / Console V2 Common | Remarks |
Provisioning Service | Console REST API V1 / Console V1 Not supported | Console REST API V2 / Console V2 Planned support | Remarks |
Angle Adjustment tool | Console REST API V1 / Console V1 Supported | Console REST API V2 / Console V2 Supported | Remarks |
Studio | Console REST API V1 / Console V1 Supported | Console REST API V2 / Console V2 Planned support | Remarks |
Brain Builder | Console REST API V1 / Console V1 Supported | Console REST API V2 / Console V2 Planned support | Remarks |
Vision Dataset Generator | Console REST API V1 / Console V1 Supported | Console REST API V2 / Console V2 Supported | Remarks |
Portal and Developer Site Updates
Documentation Moved to Portal
The following documents have been moved to the Portal:
- Console Endpoint Information
- AI Ethical Guidelines
These are now located in: Portal → Your Project Page → Support → Download
Reorganised Documentation
We have restructured our documentation to clearly separate resources for both API versions:
Guides
- The Guides top page now serves as a central hub providing access to:
Downloads
- The Downloads top page has been similarly organized with separate sections for:
Console REST API v2 Related Updates
Edge Device Firmware Updates
Important Compatibility Notice
- Once updated to v2-compatible firmware, devices CANNOT be downgraded to v1 firmware
- Console REST API v2 and v1 are not compatible with each other
- Before proceeding, please review the following documentation:
CSV26 and SZP123S-001
New Firmware Version: CSV26_SZP123S-001_V1toV2_20250318_1.0.8
Download the new firmware from Downloads.
Key Features
- Initial firmware supporting Console REST API v2
- This release updates devices from v1 firmware to v2-compatible firmware
AIH-IVRW2
Console REST API v2 is not yet supported on AIH-IVRW2 (as of April 7, 2025). Notification will be sent when support becomes available.
Console v2 Access
To access Console REST API v2 with Console REST API v2 support:
- Browser Access: Select V2 in the top-right corner (V1 is set as default)
- API Access: Use the new endpoint for API v2 functionality
- Endpoint information (PDF file) is available from: Portal → Your Project Page → Support → Download
Edge Application Development Resources
NOTE: Devices must have the latest Console REST API V2 supported edge firmware installed for sample applications to function.
Edge App SDK
- New Edge Application SDK is released with Console REST API v2 support
- Available in the Edge Applications SDK GitHub repository
Sample Applications
- New sample applications are released with Console REST API v2 support
- Available from Console REST API V2 files and resources
Angle Adjustment Tool
- Updated with Console REST API V2 support
- Available in the Angle Adjustment Tool GitHub repository
Technical Documentation
- New guides for Console REST API v2 and Console v2 are now available
- See Console REST API V2 documentation
Console REST API v1 Related Updates
There are no new updates related to Console REST API v1 since the last release on April 1, 2025.