POST
/
api
/
projects
/
{projectName}
/
models
curl --request POST \
  --url http://127.0.0.1:47334/v1/api/api/projects/{projectName}/models \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>"
}'
{
  "name": "<string>",
  "accuracy": 123,
  "active": true,
  "version": 123,
  "status": "<string>",
  "predict": "<string>",
  "mindsdb_version": "<string>",
  "error": "<string>",
  "fetch_data_query": "<string>",
  "created_at": "<string>",
  "training_time": "<string>",
  "update": "<string>"
}

The REST API playground can currently only be used with MindsDB running locally at http://127.0.0.1:47334. Support for MindsDB Cloud is in progress. In the meantime, check out our SQL example for how to use the REST API with MindsDB Cloud.

Path Parameters

projectName
string
required

The name of the project

Body

application/json
query
string

The SQL CREATE MODEL statement used to train this model. See the CREATE MODEL statement

Response

200 - application/json
name
string
accuracy
number

Accuracy of trained model between 0 and 1

active
boolean

Whether or not this model is currently the active version

version
number

Version of this model

status
string

Current status of this model (generating | creating | complete | error)

predict
string

Column name that this model predicts

mindsdb_version
string

MindsDB version associated with this model

error
string

Error encountered during training, if applicable

fetch_data_query
string

SQL query used to fetch training data for this model

created_at
string

Time model was created at in YYYY-MM-DD HH:MM:SS format (trained models only)

training_time
string

How long training this model took in HH:MM:SS format (trained models only)

update
string

Set to "available" when a new version of MindsDB is available that makes the model obsolete, or when new data is available in the data that was used to train the model (trained models only).