The applications
API endpoints can be used to manage, run, and deploy applications to Nextmv Cloud. They are also used to create and manage experiments for each application. See the Nextmv CLI reference for equivalent Nextmv CLI functionality.
Note, all requests must be authenticated with Bearer Authentication. Make sure your request has a header containing your Nextmv Cloud API key, as such:
- Key:
Authorization
- Value:
Bearer <YOUR-API-KEY>
Run execution
New application run.
Create new application run.
Get run result.
Get the result of a run.
Run management
List past runs (50 max).
List past runs for application (50 max).
Update name and description of run.
Update the name and/or description of a run.
Get run status without output.
Get the status of a run without the output.
Get run input.
Gets the input used for a run.
Retrieve unique upload URL and ID.
Retrieve a unique URL and ID for uploading run input (for large input files).
Versions
Create new version.
Create new application version using the current dev binary.
List versions.
List all versions for an application.
Get version information.
Get application version information specified by application and version ID.
Update version information.
Update application version information with defined data, specified by application and version ID.
Delete version.
Delete version, specified by application and version ID.
Instances
Create new instance.
Create new application instance for a specified version.
List instances.
List all instances for an application.
Get instance information.
Get application instance information specified by application and instance ID.
Update an instance.
Update application instance information with defined data, specified by application and instance ID.
Delete instance.
Delete application instance, specified by application and instance ID.
Experiments
Create new input set.
Create new application input set for experiments.
List input sets.
List all input sets for an application.
Update input set metadata.
Update input set metadata with defined data, specified by application and input set ID.
Get input set information.
Get input set information specified by application and input set ID.
Create and start batch experiment.
Create and start batch experiment.
List batch experiments.
List batch experiments for an application.
Get batch experiment status and results.
Get batch experiment status and results specified by application and batch ID.
List batch experiment runs.
List runs used for batch experiment specified by application and batch ID.
Admin
Get application information.
Get application information specified by application ID.
Update application information.
Update application information with defined data, specified by application ID.
Delete application.
Delete application, specified by application ID.
Usage
Below we provide an example of how to use the API in Python. You will need to get your API key and set the following environment variable:
Be sure to replace YOUR_APP_ID
with the id of the Nextmv app you wish to call in the code snippet below.
Save the code snippet to a file (e.g., as main.py
) and use it to execute a run with a valid input (e.g., input.json
):