This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Creates a new Model with no versions.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-write.
objectstringstringThe unique resource identifier (RID) of a Folder.
objectThe created Model
stringThe Resource Identifier (RID) of a Model.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/models?preview=true" \
-d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"House Pricing Model"}'1
2
3
{
"rid": "ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9"
}| Error Name | ||
|---|---|---|
Resource | Error Code | CONFLICT |
| Status Code | 409 | |
| Description | The provided resource name is already in use by another resource in the same folder. | |
| Parameters | parentFolderRid, displayName | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The display name of a Resource should not be exactly `.` or `..`, contain a forward slash `/` and must be less than or equal to 700 characters. | |
| Parameters | displayName | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the Model. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.