Skip to main content
POST
Create a prediction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

modelKey
string<uuid>
required

Body

multipart/form-data
_file
file
required

The CSV, sent as a multipart part named exactly _file. The underscore is not a typo: it is the name every caller sends and the only name the server binds.

Response

Prediction created successfully

predictionKey
string<uuid>
required
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}$
status
enum<string>
required

Status of prediction processing:

  • PENDING - The prediction has been successfully created and is pending execution
  • RUNNING - The prediction is currently being processed. When this status is returned, an url for progress check is returned too
  • COMPLETED - The prediction has been successfully completed. An url to download the result as CSV is provided in the response
  • FAILED - The prediction execution has failed
  • TIMEOUT - The prediction execution has timed out
Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED,
TIMEOUT
predictionCreationProgressUrl
string
required