Skip to main content
GET
/
api
/
v1
/
predictions
/
{predictionKey}
Get prediction
curl --request GET \
  --url https://api.mathfi.ai/api/v1/predictions/{predictionKey} \
  --header 'Authorization: Bearer <token>'
{
  "predictionKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "datasetKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PENDING",
  "predictionResultDownloadUrl": "<string>",
  "createdOn": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Obtain a token from POST /api/login. Valid for 1 hour.

Path Parameters

​
predictionKey
string<uuid>
required

Response

Prediction retrieved successfully

​
predictionKey
string<uuid>
required
​
modelKey
string<uuid>
required
​
datasetKey
string<uuid>
required
​
status
enum<string>
required

Status of a prediction job:

StatusDescription
PENDINGCreated, queued for processing
RUNNINGInference in progress
COMPLETEDFinished. Result CSV available for download.
FAILEDFailed due to an error
TIMEOUTExceeded the processing time limit
Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED,
TIMEOUT
​
predictionResultDownloadUrl
string

Signed URL to download the prediction result CSV. Present when status is COMPLETED.

​
createdOn
string<date-time>