modzyClient.getModel
Retrieve model details
modzyClient.getModel(modelId)
Returns model details. It includes the modelId
, latestVersion
, author
, name
, versions
, and tags
.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
modelId | string | A model identifier assigned by Modzy. | 'ed542963de' |
Returns
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/Model",
"definitions": {
"Model": {
"type": "object",
"additionalProperties": false,
"properties": {
"modelId": {
"type": "string"
},
"latestVersion": {
"type": "string"
},
"latestActiveVersion": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"type": "string"
}
},
"author": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"permalink": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"$ref": "#/definitions/Feature"
}
},
"isActive": {
"type": "boolean"
},
"isRecommended": {
"type": "boolean"
},
"isCommercial": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
}
},
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/Image"
}
},
"snapshotImages": {
"type": "array",
"items": {}
},
"lastActiveDateTime": {
"type": "string",
"format": "date-time"
},
"visibility": {
"$ref": "#/definitions/Visibility"
}
},
"required": [
"author",
"description",
"features",
"images",
"isActive",
"isCommercial",
"isRecommended",
"lastActiveDateTime",
"latestActiveVersion",
"latestVersion",
"modelId",
"name",
"permalink",
"snapshotImages",
"tags",
"versions",
"visibility"
]
},
"Feature": {
"type": "object",
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"identifier",
"name"
]
},
"Image": {
"type": "object",
"additionalProperties": false,
"properties": {
"url": {
"type": "string"
},
"caption": {
"type": "string"
},
"relationType": {
"type": "string"
}
},
"required": [
"caption",
"relationType",
"url"
]
},
"Tag": {
"type": "object",
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string"
},
"name": {
"type": "string"
},
"dataType": {
"type": "string"
},
"isCategorical": {
"type": "boolean"
}
},
"required": [
"dataType",
"identifier",
"isCategorical",
"name"
]
},
"Visibility": {
"type": "object",
"additionalProperties": false,
"properties": {
"scope": {
"type": "string"
}
},
"required": [
"scope"
]
}
}
}
Examples
model = modzyClient.getModel('ed542963de')
console.table(model)
Updated over 2 years ago