SIsimscale
AI Models

Get the status of an AI prediction, and its results if it is done

get/ai/predictions/{predictionId}

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/ai/predictions/{predictionId}
  • Auth
    API key in header X-API-KEY

Path parameters

predictionIdstring uuid required

Response

The status of the prediction, and the results if it is done

predictionIdstring uuid
resultIdstring uuid
confidenceScorenumber double
statusstring

RUNNING - Prediction is still in progress DONE - Prediction is done, the results are part of this response FAILED - Prediction failed, either because the simulation is not compatible with the AI model, or because of a transient error. Retrying can help in the second case.

Changes

No operation changes recorded.