VirtuousAI
Reference

Ml models

List Models

GET
/api/v1/ml/models

Query Parameters

status?|
sort?string
Default"recent"
Match^(recent|name)$
limit?integer
Default50
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models"
{
  "has_next": true,
  "limit": 0,
  "models": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "current_version": 0,
      "id": "string",
      "ladder_rung": "string",
      "last_evaluation_at": "2019-08-24T14:15:22Z",
      "last_evaluation_metrics": {},
      "name": "string",
      "purpose": "string",
      "slug": "string",
      "status": "healthy",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Archived Models

GET
/api/v1/ml/models/archived

Query Parameters

limit?integer
Default50
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/archived"
{
  "has_next": true,
  "limit": 0,
  "models": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "current_version": 0,
      "id": "string",
      "ladder_rung": "string",
      "last_evaluation_at": "2019-08-24T14:15:22Z",
      "last_evaluation_metrics": {},
      "name": "string",
      "purpose": "string",
      "slug": "string",
      "status": "healthy",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "offset": 0,
  "total": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Model

GET
/api/v1/ml/models/{model_slug}

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string"
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_version": 0,
  "feature_label_mapping": {
    "property1": "string",
    "property2": "string"
  },
  "feedback_degradation_threshold": "string",
  "feedback_evaluation_cadence": "string",
  "feedback_outcome_signal": "string",
  "id": "string",
  "knowledge_context": {},
  "ladder_history": [
    {}
  ],
  "ladder_rung": "string",
  "last_evaluation_at": "2019-08-24T14:15:22Z",
  "last_evaluation_metrics": {},
  "mlflow_experiment_id": "string",
  "mlflow_model_name": "string",
  "name": "string",
  "purpose": "string",
  "slug": "string",
  "status": "healthy",
  "updated_at": "2019-08-24T14:15:22Z",
  "version_history": [
    {}
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Model

DELETE
/api/v1/ml/models/{model_slug}

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

curl -X DELETE "https://loading/api/v1/ml/models/string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Approaches

GET
/api/v1/ml/models/{model_slug}/approaches

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/approaches"
{
  "approaches": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "ladder_rung": "string",
      "name": "string",
      "slug": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Approach

GET
/api/v1/ml/models/{model_slug}/approaches/{approach_slug}

Path Parameters

model_slug*string
approach_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/approaches/string"
{
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "string",
  "ladder_rung": "string",
  "name": "string",
  "slug": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Delete Approach

DELETE
/api/v1/ml/models/{model_slug}/approaches/{approach_slug}

Path Parameters

model_slug*string
approach_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

curl -X DELETE "https://loading/api/v1/ml/models/string/approaches/string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Code File

GET
/api/v1/ml/models/{model_slug}/approaches/{approach_slug}/code/{file}

Path Parameters

model_slug*string
approach_slug*string
file*string

Query Parameters

ref?|

Git commit SHA or branch

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/approaches/string/code/string"
{
  "commit_id": "string",
  "content": "string",
  "exists": true,
  "path": "string",
  "recent_commits": [
    {
      "property1": "string",
      "property2": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Put Code File

PUT
/api/v1/ml/models/{model_slug}/approaches/{approach_slug}/code/{file}

Path Parameters

model_slug*string
approach_slug*string
file*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

content*string
message?string
Default""

Response Body

application/json

application/json

curl -X PUT "https://loading/api/v1/ml/models/string/approaches/string/code/string" \  -H "Content-Type: application/json" \  -d '{    "content": "string"  }'
{
  "commit_id": "string",
  "is_new": true,
  "path": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Archive Model

POST
/api/v1/ml/models/{model_slug}/archive

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ml/models/string/archive"
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_version": 0,
  "id": "string",
  "ladder_rung": "string",
  "last_evaluation_at": "2019-08-24T14:15:22Z",
  "last_evaluation_metrics": {},
  "name": "string",
  "purpose": "string",
  "slug": "string",
  "status": "healthy",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Assess Model

GET
/api/v1/ml/models/{model_slug}/assessment

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/assessment"
{
  "assessment": "string",
  "recommended_run_id": "string",
  "recommended_run_name": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Start Evaluating

POST
/api/v1/ml/models/{model_slug}/evaluate

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

run_id*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ml/models/string/evaluate" \  -H "Content-Type: application/json" \  -d '{    "run_id": "string"  }'
{
  "alias": "challenger",
  "model_name": "string",
  "version": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Ml Jobs

GET
/api/v1/ml/models/{model_slug}/jobs

Path Parameters

model_slug*string

Query Parameters

job_type?|
limit?integer
Default50
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/jobs"
{
  "jobs": [
    {
      "completed_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "id": "string",
      "job_id": "string",
      "job_type": "string",
      "mlflow_run_id": "string",
      "model_uri": "string",
      "started_at": "2019-08-24T14:15:22Z",
      "status": "string",
      "submitted_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Job Predictions

GET
/api/v1/ml/models/{model_slug}/jobs/{job_id}/predictions

Path Parameters

model_slug*string
job_id*string

Query Parameters

limit?integer
Default100
Range1 <= value <= 1000

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/jobs/string/predictions"
{
  "columns": [
    "string"
  ],
  "rows": [
    {}
  ],
  "table_name": "string",
  "total_rows": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Prediction Results

GET
/api/v1/ml/models/{model_slug}/predictions/{job_id}

Path Parameters

model_slug*string
job_id*string

Query Parameters

preview_rows?integer
Default10
Range1 <= value <= 100

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/predictions/string"
{
  "files": [],
  "job_id": "string",
  "mlflow_run_id": "string",
  "preview": {
    "property1": [
      {}
    ],
    "property2": [
      {}
    ]
  },
  "status": "pending"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Promote To Champion

POST
/api/v1/ml/models/{model_slug}/promote

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

run_id*string

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ml/models/string/promote" \  -H "Content-Type: application/json" \  -d '{    "run_id": "string"  }'
{
  "alias": "champion",
  "model_name": "string",
  "version": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Model Registry

GET
/api/v1/ml/models/{model_slug}/registry

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/registry"
{
  "challengers": [
    {
      "aliases": [
        "string"
      ],
      "approach_name": "string",
      "approach_slug": "string",
      "artifact_id": "string",
      "creation_timestamp": 0,
      "display_name": "",
      "run_id": "string",
      "run_metrics": {
        "property1": 0,
        "property2": 0
      },
      "run_name": "string",
      "run_params": {
        "property1": "string",
        "property2": "string"
      },
      "status": "string",
      "version": "string"
    }
  ],
  "champion": {
    "aliases": [
      "string"
    ],
    "approach_name": "string",
    "approach_slug": "string",
    "artifact_id": "string",
    "creation_timestamp": 0,
    "display_name": "",
    "run_id": "string",
    "run_metrics": {
      "property1": 0,
      "property2": 0
    },
    "run_name": "string",
    "run_params": {
      "property1": "string",
      "property2": "string"
    },
    "status": "string",
    "version": "string"
  },
  "has_registry": true
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Restore Model

POST
/api/v1/ml/models/{model_slug}/restore

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X POST "https://loading/api/v1/ml/models/string/restore"
{
  "created_at": "2019-08-24T14:15:22Z",
  "current_version": 0,
  "id": "string",
  "ladder_rung": "string",
  "last_evaluation_at": "2019-08-24T14:15:22Z",
  "last_evaluation_metrics": {},
  "name": "string",
  "purpose": "string",
  "slug": "string",
  "status": "healthy",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Model Runs

GET
/api/v1/ml/models/{model_slug}/runs

Path Parameters

model_slug*string

Query Parameters

max_results?integer
Default25
Range1 <= value <= 100

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/runs"
{
  "experiment_id": "string",
  "runs": [
    {
      "end_time": 0,
      "metrics": {
        "property1": 0,
        "property2": 0
      },
      "params": {
        "property1": "string",
        "property2": "string"
      },
      "run_id": "string",
      "run_name": "string",
      "start_time": 0,
      "status": "string",
      "thread_id": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Run Logs

GET
/api/v1/ml/models/{model_slug}/runs/{run_id}/logs

Path Parameters

model_slug*string
run_id*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/runs/string/logs"
{
  "logs": "string",
  "run_id": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Stop Evaluating

POST
/api/v1/ml/models/{model_slug}/stop-evaluating

Path Parameters

model_slug*string

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Request Body

application/json

run_id*string

Response Body

application/json

curl -X POST "https://loading/api/v1/ml/models/string/stop-evaluating" \  -H "Content-Type: application/json" \  -d '{    "run_id": "string"  }'
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

List Training Runs

GET
/api/v1/ml/models/{model_slug}/training-runs

Path Parameters

model_slug*string

Query Parameters

max_results?integer
Default25
Range1 <= value <= 100

Header Parameters

authorization?|
X-API-Key?|
vai_token?|

Response Body

application/json

application/json

curl -X GET "https://loading/api/v1/ml/models/string/training-runs"
{
  "experiment_id": "string",
  "failed": [
    {
      "approach_name": "string",
      "approach_slug": "string",
      "artifact_id": "string",
      "code_commit": "string",
      "end_time": 0,
      "experiment_id": "string",
      "metrics": {
        "property1": 0,
        "property2": 0
      },
      "origin_thread_id": "string",
      "params": {
        "property1": "string",
        "property2": "string"
      },
      "run_id": "string",
      "run_name": "string",
      "start_time": 0,
      "status": "string",
      "task_run_id": "string",
      "task_status": "string"
    }
  ],
  "in_flight": [
    {
      "approach_name": "string",
      "approach_slug": "string",
      "artifact_id": "string",
      "code_commit": "string",
      "end_time": 0,
      "experiment_id": "string",
      "metrics": {
        "property1": 0,
        "property2": 0
      },
      "origin_thread_id": "string",
      "params": {
        "property1": "string",
        "property2": "string"
      },
      "run_id": "string",
      "run_name": "string",
      "start_time": 0,
      "status": "string",
      "task_run_id": "string",
      "task_status": "string"
    }
  ],
  "versions": [
    {
      "approach_name": "string",
      "approach_slug": "string",
      "artifact_id": "string",
      "code_commit": "string",
      "end_time": 0,
      "experiment_id": "string",
      "metrics": {
        "property1": 0,
        "property2": 0
      },
      "origin_thread_id": "string",
      "params": {
        "property1": "string",
        "property2": "string"
      },
      "run_id": "string",
      "run_name": "string",
      "start_time": 0,
      "status": "string",
      "task_run_id": "string",
      "task_status": "string"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Missions

Previous Page

Notifications

Next Page