Version

The Version endpoint provides information about the current API version and supported endpoints. For AI-powered endpoints, it also includes ML model version information.

GET/v1/version

Get API version

Retrieve information about the current API version and supported endpoints. This endpoint doesn't require authentication and can be used to verify API availability.

Response fields

Name
version
Type
string
Description
The current API version number.
Name
apiStatus
Type
string
Description
Current API status (operational, maintenance, degraded).
Name
endpoints
Type
object
Description
Available endpoint categories with their versions and status. AI-powered endpoints include model_version and service_version.

Request

GET

/v1/version

curl https://frontier.beamery.com/v1/version

Response

{
  "version": "1.0.0",
  "apiStatus": "operational",
  "endpoints": {
    "authentication": {
      "status": "operational",
      "version": "1.0.0"
    },
    "taxonomy": {
      "status": "operational",
      "version": "1.0.0",
      "model_version": "1.0.0",
      "service_version": "4.9.250530.1844409513"
    },
    "inference": {
      "status": "operational",
      "version": "1.0.0",
      "model_version": "1.0.0",
      "service_version": "4.9.250530.1844409513"
    },
    "matching": {
      "status": "operational",
      "version": "2.0.0",
      "model_version": "1.0.0",
      "service_version": "4.9.250530.1844409513"
    },
    "companies": {
      "status": "alpha",
      "version": "0.8.0"
    },
    "corecrm": {
      "status": "operational",
      "version": "1.0.0"
    }
  }
}

POST/v1/version/check

Check version compatibility

Check if a specific client version is compatible with the current API version.

Request body

Name
clientVersion
Type
string
Description
The API version your client is using.
Name
endpoints
Type
array
Description
List of endpoints your client uses.

Response fields

Name
compatible
Type
boolean
Description
Whether the client version is compatible.
Name
supported
Type
boolean
Description
Whether the client version is still supported.
Name
endpointCompatibility
Type
object
Description
Compatibility status for each requested endpoint.

Request

POST

/v1/version/check

curl https://frontier.beamery.com/v1/version/check \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "clientVersion": "0.9.0",
    "endpoints": ["taxonomy", "matching", "inference"]
  }'

Response

{
  "compatible": true,
  "supported": true,
  "endpointCompatibility": {
    "taxonomy": {
      "compatible": true,
      "version": "1.0.0",
      "model_version": "1.0.0"
    },
    "matching": {
      "compatible": true,
      "version": "2.0.0",
      "model_version": "1.0.0",
      "notes": "Using v2 matching which is backwards compatible"
    },
    "inference": {
      "compatible": true,
      "version": "1.0.0",
      "model_version": "1.0.0"
    }
  }
}