---
title: "Create Model Object"
method: POST
path: "/api/custom-entity/v2/models"
tags: ["Model Management"]
---

# Create Model Object

`POST /api/custom-entity/v2/models`

## Request

- Base URL: `https://hostname/api/custom-entity`
- URL: `https://hostname/api/custom-entity/api/custom-entity/v2/models`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `object-manager`, `object-manager-write`, `integration`

Use this API to create a new Model object record.

> 🗒 Things to Know
> 
> - This API only supports creating Model objects via Object Manager.

## Request body

- ModelCreateRequest
  - `name` string, required: The name of the object.
  - `description` string: The description of the object.
  - `modelVersion` string: The version of the model.
  - `limitations` string: The limitations of the model.
  - `biases` string: The known biases of the model.
  - `demographicParityDifference` string, decimal: The demographic parity difference measurement.
  - `demographicParityRatio` string, decimal: The demographic parity ratio measurement.
  - `equalizedOddsDifference` string, decimal: The equalized odds difference measurement.
  - `equalizedOddsRatio` string, decimal: The equalized odds ratio measurement.
  - `referenceLink` string, uri: The reference link or other URL.
  - `hubReferenceId` string: The hub reference identifier to cross-reference model repositories.
  - `modelSource` 'Internal Development' | 'Vendor' | 'Open Source' | 'Third Party': The source of the model.
  - `additionalAttributes` object: This parameter can be used to store attribute details in key value pairs.
  - `entityDetail` EntityDetailRequest
    - `extendedBaseAttributes` object: The details of the attribute.
  - `orgGroupId` EntityOrganizationInformation
    - `id` string, uuid, required: The unique identifier of the organization.
    - `name` string: The name of the organization.

## Response `201`

Model entity created successfully

- EntityInformation
  - `id` string, uuid, required: The unique identifier of the object.
  - `number` integer, required: The sequential order in which the object was created.
  - `name` string, required: The name of the object.
  - `orgGroupId` string, uuid: The unique identifier of the organization responsible for the object.
  - `schemaId` string, uuid, required: The unique identifier of the schema.
  - `entityType` BasicEntityTypeInformation, required
    - `id` string, uuid, required: The unique identifier of the object type.
    - `name` string, required: The name of the object type.
    - `seeded` boolean: This flag indicates whether the object type is seeded.
    - `moduleName` 'Vendor' | 'DataMapping' | 'Risk' | 'Assessments' | 'CustomEntityManagement': The name of the product where the object type exists.
    - `schemaName` 'vendor' | 'data-mapping' | 'risk' | 'assessments' | 'customEntityManagement': The name of the schema.
  - `workflowAndStage` EntityWorkflowInformation
    - `id` string, uuid, required: The unique identifier of the workflow.
    - `name` string, required: The name of the workflow.
    - `type` string, required: The type of workflow.
    - `workflowMode` 'ADVANCED, BASIC': The mode in which the workflow was created.
    - `stageId` string, uuid, required: The unique identifier of the workflow stage.
    - `stageName` string, required: The name of the workflow stage.
  - `attributes` object: The details of the associated attributes.
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required: The date and time that the record was created.
    - `lastUpdatedDate` string, date-time: The date and time that the record was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the record.
      - `name` string: The name of the user who last modified the record.
      - `email` string: The email address of the user who last modified the record.
      - `initials` string: The initials of the user who last modified the record.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the record.
      - `name` string: The name of the user who last modified the record.
      - `email` string: The email address of the user who last modified the record.
      - `initials` string: The initials of the user who last modified the record.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/platform-object-manager.md) - [All operations](https://skmtc.dev/onetrust/apis/platform-object-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/platform-object-manager/revisions/76e5833717c3?raw)