API Reference
Log In
API Reference

Run a model

This endpoint tests a model run with the sample inputs. It spins up the model container image, calls the /status route, and finally the /run route.

🚧

Only the model creator can call this route.

🚧

Steps 1, 2, 3, 4, 7, and 8 of the Model Deployment are required to run this route.

🚧

At this stage, the model needs to be already loaded and in partial status.

📘

In case of exception, a technicalInformation field is returned with troubleshooting details.

👍

Roles

Data Scientists can access this route.

Path Params
string
required

A model identifier provided by Modzy. It contains 10 random alphanumeric characters.

string
required

The model’s version number. It follows the semantic versioning format.

Query Params
boolean

Verifies if the model can return explanations.

Responses

Language
Credentials
Request
Choose an example:
application/json