Create Model

name required	string The models name
packageId required	string The model this model is derived from
description	string or null description of the model default 'My model'
projectId required	string the id of the project the model belongs to
scope	string or null Field that shows the scope in which the model exists default 'project' Enum: "private" "project" "org" "public"
status	string or null the current models status default ModelStatus.CREATED Enum: "created" "pending" "training" "trained" "deployed" "failed"
tags	Array of strings or null Tags related to the model default []
labels	Array of strings or null Labels related to the model
	object or null The configuration that the model was created with default {}
inputType	string or null Model Input Type default ModelInputType.IMAGE Enum: "image" "video" "text" "audio"
outputType	string or null Model Output Type default AnnotationType.BOX Enum: "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text"
datasetId	string or null The datasets id that the model is connected to
	Array of ItemArtifact (object) or LocalArtifact (object) or null the artifacts of the model an artifact indicates where the model binaries sit
	object or null
moduleName	string or null The module name of the model
property name* additional property	any

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/ml/models

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"name": "string",
"packageId": "string",
"description": "string",
"projectId": "string",
"scope": "private",
"status": "created",
"tags": ["string"
],
"labels": ["string"
],
"configuration": {"label_to_id_map": {"property1": 0,
"property2": 0
}
},
"inputType": "image",
"outputType": "class",
"datasetId": "string",
"artifacts": [{"type": "item",
"itemId": "string"
}
],
"metadata": {"system": {"archived": true,
"ontologyId": "string",
"train": {"datasets": ["string"
],
"services": ["string"
],
"executions": ["string"
]
},
"predict": {"datasets": ["string"
],
"services": ["string"
],
"executions": ["string"
]
},
"evaluate": {"datasets": ["string"
],
"services": ["string"
],
"executions": ["string"
]
},
"deploy": {"datasets": ["string"
],
"services": ["string"
],
"executions": ["string"
]
},
"subsets": {"train": {"property1": null,
"property2": null
},
"validation": {"property1": null,
"property2": null
}
}
}
},
"moduleName": "string"
}

Response samples

application/json

{"name": "My Model",
"description": "My Model Description",
"packageId": "packageId",
"projectId": "projectId"
}