View all methods

aiCodeInsights.currentVersion

Get the current version of the DX AI Code Insights daemon and, optionally, an installer download URL for a specific operating system. Use this endpoint to automate package downloads for enterprise deployment.

Facts

Method GET https://yourinstance.getdx.net/api/aiCodeInsights.currentVersion

Authentication

Pass a Data Cloud API key or your AI Code Insights organization token in the Authorization: Bearer <token> header. The AI Code Insights token is available under AdminAI Code Insights.

Optional arguments

Name Type Description
os String Operating system to get an installer URL for. One of macos, windows, linux.

Usage info

A successful response always includes current_version, the latest available daemon version.

If os is provided, the response also includes installer_url for that operating system.

Field Type Description
current_version String The latest available version of the AI Code Insights daemon.
installer_url String Download URL for the installer matching the requested os. Only present when os is provided.

Installer URLs point to software.getdx.net and do not require authentication. Do not send the API token when downloading the installer. See the changelog for release notes.

Example requests

Without the os parameter, the response only includes current_version:

curl "https://yourinstance.getdx.net/api/aiCodeInsights.currentVersion" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx"

Example response (version numbers are illustrative):

{
  "ok": true,
  "current_version": "0.6.0"
}

With the os parameter, the response also includes installer_url:

curl "https://yourinstance.getdx.net/api/aiCodeInsights.currentVersion?os=macos" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx"

Example response:

{
  "ok": true,
  "current_version": "0.6.0",
  "installer_url": "https://software.getdx.net/ai-code-metrics/dx-ai-insights-0.6.0-darwin.pkg"
}

Errors

This table lists common errors for this method. Other errors can be returned if the service is unavailable or an unexpected failure occurs. Callers should always check the ok field in the response.

Error Description
not_authed The request did not include a valid API key or AI Code Insights token.
not_connected No DX connection is configured for this Data Cloud instance.
invalid_platform The os value is not one of macos, windows, linux.