Create Model Object

post

https://{hostname}/api/custom-entity/api/custom-entity/v2/models

Use this API to create a new Model object record.

🗒
Things to Know

This API only supports creating Model objects via Object Manager.

Body Params

name

string

required

length between 3 and 255

The name of the object.

description

string

length ≤ 1000

The description of the object.

modelVersion

string

The version of the model.

limitations

string

length ≤ 2000

The limitations of the model.

biases

string

length ≤ 2000

The known biases of the model.

demographicParityDifference

string

The demographic parity difference measurement.

demographicParityRatio

string

The demographic parity ratio measurement.

equalizedOddsDifference

string

The equalized odds difference measurement.

equalizedOddsRatio

string

The equalized odds ratio measurement.

referenceLink

uri

length ≤ 2048

The reference link or other URL.

hubReferenceId

string

length ≤ 100

The hub reference identifier to cross-reference model repositories.

modelSource

string

enum

Defaults to Internal Development

The source of the model.

Allowed:

additionalAttributes

object

This parameter can be used to store attribute details in key value pairs.

entityDetail

object

The details of the object.

orgGroupId

object

The unique identifier of the organization responsible for the object.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Model entity created successfully

429Too Many Requests. For more information, see API Rate Limits.