Get prediction detail
curl --request GET \
--url https://{tenant}-api.mathfi.ai/api/v1/predictions/{predictionKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}-api.mathfi.ai/api/v1/predictions/{predictionKey}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"predictionKey": "3a1a9a83-d549-4f25-b7ed-8174e0c955de",
"modelKey": "4a1a9a83-d549-4f25-b7ed-8174e0c955da",
"datasetKey": "2b0a9a83-d549-4f25-b7ed-8174e0c955cd",
"targetPerformance": 0.87,
"achievedPerformance": 0.89,
"status": "COMPLETED",
"predictionResultUrl": "https://server/prediction-result.csv"
}Predictions
Get prediction detail
Get prediction
GET
/
api
/
v1
/
predictions
/
{predictionKey}
Get prediction detail
curl --request GET \
--url https://{tenant}-api.mathfi.ai/api/v1/predictions/{predictionKey} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}-api.mathfi.ai/api/v1/predictions/{predictionKey}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"predictionKey": "3a1a9a83-d549-4f25-b7ed-8174e0c955de",
"modelKey": "4a1a9a83-d549-4f25-b7ed-8174e0c955da",
"datasetKey": "2b0a9a83-d549-4f25-b7ed-8174e0c955cd",
"targetPerformance": 0.87,
"achievedPerformance": 0.89,
"status": "COMPLETED",
"predictionResultUrl": "https://server/prediction-result.csv"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Prediction detail successful response
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Example:
"3a1a9a83-d549-4f25-b7ed-8174e0c955de"
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Example:
"4a1a9a83-d549-4f25-b7ed-8174e0c955da"
Pattern:
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$Example:
"c3a9a83-d549-4f25-b7ed-8174e0c955da"
Status of prediction processing:
PENDING- The prediction has been successfully created and is pending executionRUNNING- The prediction is currently being processed. When this status is returned, an url for progress check is returned tooCOMPLETED- The prediction has been successfully completed. An url to download the result as CSV is provided in the responseFAILED- The prediction execution has failedTIMEOUT- The prediction execution has timed out
Available options:
PENDING, RUNNING, COMPLETED, FAILED, TIMEOUT The version of the model this prediction actually ran against, recorded when it ran. A run always goes against whichever version was the champion at the time, so this is the only thing that says which one that was — re-pointing the champion afterwards does not change what an earlier prediction meant.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes