API

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.

All requests must be authenticated with Bearer Authentication. Make sure your request has a header containing your Nextmv Cloud API key:

• Key: Authorization
• Value: Bearer <YOUR-API-KEY>

Authorization: Bearer <YOUR-API-KEY>

We strongly encourage you to see the list of available endpoints directly in Console. The endpoints are tailored to your specific application. You will find the same collection of endpoints in this page, but with the correct parameters already filled in.

Run execution

Sample curl request for creating a new run (the run_id is returned for a successful request):

curl -sS -L -X POST \
  "https://api.cloud.nextmv.io/v1/applications/$APP_ID/runs?instance_id=$INSTANCE_ID" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $NEXTMV_API_KEY" \
  -d $(cat $INPUT_FILE | jq '{"input": ., "options": {"duration": "2"}}' -c) | jq

Run metadata

The run metadata can be retrieved while the run is still in progress (or at any point). The metadata.status key will contain the status of the run.

Sample curl request for obtaining metadata for a run:

curl -sS -L -X GET \
  "https://api.cloud.nextmv.io/v1/applications/$APP_ID/runs/$RUN_ID/metadata" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $NEXTMV_API_KEY" | jq

Run result

When you retrieve the full results of a run, the output key will contain the actual output of the run.

Sample curl request for getting a run result:

curl -sS -L -X GET \
  "https://api.cloud.nextmv.io/v1/applications/$APP_ID/runs/$RUN_ID" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $NEXTMV_API_KEY" | jq

Run management

Sample curl request for getting queued runs:

curl -L -X GET \
  "https://api.cloud.nextmv.io/v1/account/queue" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $NEXTMV_API_KEY"

Sample curl request for canceling a run:

curl -L -X PATCH \
  "https://api.cloud.nextmv.io/v1/applications/$APP_ID/runs/$RUN_ID/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $NEXTMV_API_KEY"

The uploadurl endpoint is for submitting large input files for a run. A walk-through of how to submit and retrieve large files for runs can be found in the large payloads section.

Versions

Instances

Inputs

Input sets

Batch Experiments

Acceptance tests

Shadow Tests

Switchback Tests

Ensembles

Admin