--- updatedAt: 2026-05-27T12:50:22.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # Create Model Object Use this API to create a new Model object record. > 🗒 Things to Know > > - This API only supports creating Model objects via Object Manager. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Platform - Object Manager", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Object Manager APIs are used to integrate external systems and streamline the flow of data for objects created via Object Manager in the OneTrust Platform." }, "servers": [ { "url": "https://{hostname}/api/custom-entity", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Model Management", "description": "The Model Management APIs are used to conduct full management of Model objects.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/platform-object-manager.json" } } ], "x-onetrust": { "spec-label": "OpenAPI 3.1.0", "links": [ "{'Object Manager': 'https://my.onetrust.com/s/topic/0TO3q000000JPkQGAW/object-manager'}" ] }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "paths": { "/api/custom-entity/v2/models": { "post": { "operationId": "createModelUsingPOST", "summary": "Create Model Object", "description": "Use this API to create a new Model object record.\n\n> 🗒 Things to Know\n> \n> - This API only supports creating Model objects via Object Manager.", "tags": [ "Model Management" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-object-manager.json" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCreateRequest" }, "examples": { "Basic Model": { "summary": "Basic AI model creation example", "description": "A simple model creation request with minimal required fields", "value": { "name": "kyutai/mimi", "description": "Mimi is a high-fidelity audio codec leveraging neural networks.", "referenceLink": "https://huggingface.co/kyutai/mimi", "biases": "The model has been trained with a few safeguards to try to limit potential toxic usages.", "limitations": "The model has been trained with a few safeguards to try to limit potential toxic usages.", "organization": { "id": "c9e5a35b-9be7-4dd6-adac-0bee7c02384f" }, "entityDetail": [] } }, "Comprehensive Model": { "summary": "Detailed AI model creation example", "description": "A comprehensive model creation request with fairness metrics", "value": "{\n \"name\": \"timm/mobilenetv3_small_100.lamb_in1k\",\n \"description\": \"A MobileNet-v3 image classification model.\",\n \"referenceLink\": \"https://huggingface.co/timm/mobilenetv3_small_100.lamb_in1k\"\n \"biases\": \"May have cultural bias based on training data\",\n \"limitations\": \"Requires high computational resources and may have latency issues for real-time processing\",\n \"demographicParityDifference\": \"0.05\",\n \"demographicParityRatio\": \"0.92\",\n \"equalizedOddsDifference\": \"0.07\",\n \"equalizedOddsRatio\": \"0.89\",\n \"modelVersion\": \"2.3.1\",\n \"additionalAttributes\": {\n \"generativeAI\": [{\n \"id\": \"de8c2b96-6393-42d3-bd0d-56c35cc18c7e\"\n }],\n \"framework\": [{\n \"id\": \"d1f9e973-8a10-4634-ac05-856ea71532e9\"\n }],\n \"hostingProvider\": [{\n \"id\": \"20841322-b61d-4b47-bfaf-f84d9699578a\"\n }],\n \"programmingLanguage\": [{\n \"id\": \"7d2d9553-677e-4902-94fc-3a56d2a14aeb\"\n }],\n \"typeofLearning\": [{\n \"id\": \"3c84bf17-5440-4010-ad8b-c721d9aa11c7\"\n }],\n \"taskType\": [{\n \"id\": \"55d5462e-58dc-4eb6-8e08-74aa0006b722\"\n }]\n },\n \"organization\": {\n \"id\": \"c9e5a35b-9be7-4dd6-adac-0bee7c02384f\"\n },\n \"entityDetail\": [{ \"owner\": \"41955b71-e581-4187-ab6c-d00d1403350c\"\n \"internalOrThirdParty\": \"da570b8b-6f52-4b67-b009-fd2e427da9ab\"\n }],\n}" } } } } }, "responses": { "201": { "description": "Model entity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityInformation" }, "examples": { "Created Model Response": { "summary": "Example of a successfully created model", "description": "Response containing the details of the newly created model entity", "value": { "id": "75bb925e-1f3d-409c-8498-f62cbb09b1fc", "number": 119, "name": "timm/mobilenetv3_small_100.lamb_in1k", "organization": { "id": "c9e5a35b-9be7-4dd6-adac-0bee7c02384f", "name": "PLTF REP" }, "schemaId": "e09e39bc-fcd7-4fd1-865e-5bb8f224c542", "entityType": { "id": "286aeb99-fe6c-4f01-baaa-e24b8e689a84", "name": "models", "nameKey": "CE.Models.Name", "seeded": true, "moduleName": "CustomEntityManagement", "schemaName": "models" }, "workflow": { "id": "3b640b0b-aa83-4c45-a42e-6dec169febbc", "name": "Default Workflow", "nameKey": "CE.Models.Workflow.Name", "type": "286aeb99-fe6c-4f01-baaa-e24b8e689a84", "workflowMode": null }, "stage": { "id": "2920fe51-e469-4322-b027-96d4ea8cf208", "name": "Ideation", "nameKey": "CE.Workflow.Model.Stage.Ideation", "badgeColor": "New", "sequence": null }, "createdDate": "2025-06-09T07:38:26.141Z", "lastModifiedDate": "2025-06-09T07:38:26.141Z", "createdBy": [ { "id": "41955b71-e581-4187-ab6c-d00d1403350c", "value": "Arpita K", "disabled": false } ], "lastModifiedBy": [ { "id": "41955b71-e581-4187-ab6c-d00d1403350c", "value": "Arpita K", "disabled": false } ], "hostingProvider": [ { "id": "20841322-b61d-4b47-bfaf-f84d9699578a", "value": "Amazon Web Services (AWS)", "valueKey": "CE.Models.Attribute.HostingProvider.OptiAmazonWebServices", "disabled": false } ], "owner": [ { "id": "41955b71-e581-4187-ab6c-d00d1403350c", "value": "Arpita K", "disabled": false } ], "autonomyLevel": [ { "id": "dd4d3f0f-846c-4dc8-9375-8fa639f707bb", "value": "Human Support", "valueKey": "CE.Models.Attribute.AutonomyLevel.Option.HumanSupport", "disabled": false } ], "internalOrThirdParty": [ { "id": "da570b8b-6f52-4b67-b009-fd2e427da9ab", "value": "Self-managed open source software", "valueKey": "CE.Models.Attribute.InternalOrThirdParty.Option.SelfManagedOpenSourceSoftware", "disabled": false } ], "taskType": [ { "id": "55d5462e-58dc-4eb6-8e08-74aa0006b722", "value": "Image Classification", "valueKey": "CE.Models.Attribute.TaskType.Option.ImageClassification", "disabled": false } ], "framework": [ { "id": "d1f9e973-8a10-4634-ac05-856ea71532e9", "value": "AutoML", "valueKey": "CE.Models.Attribute.Framework.Option.AutoML", "disabled": false } ], "typeofLearning": [ { "id": "3c84bf17-5440-4010-ad8b-c721d9aa11c7", "value": "Supervised", "valueKey": "CE.Models.Attribute.TypeofLearning.OptioSupervised", "disabled": false } ], "generativeAI": [ { "id": "de8c2b96-6393-42d3-bd0d-56c35cc18c7e", "value": "Yes", "valueKey": "CE.Models.Attribute.GenerativeAI.Option.Yes", "disabled": false } ], "programmingLanguage": [ { "id": "7d2d9553-677e-4902-94fc-3a56d2a14aeb", "value": "R Programming", "valueKey": "CE.Models.Attribute.ProgrammingLanguage.RProgramming", "disabled": false } ], "equalizedOddsDifference": [ { "id": null, "value": "0.07", "disabled": false } ], "openItemsCount": [ { "id": null, "value": "0", "disabled": false } ], "modelVersion": [ { "id": null, "value": "2.3.1", "disabled": false } ], "biases": [ { "id": null, "value": "text", "disabled": false } ], "equalizedOddsRatio": [ { "id": null, "value": "0.89", "disabled": false } ], "description": [ { "id": null, "value": "A MobileNet-v3 image classification model.", "disabled": false } ], "demographicParityRatio": [ { "id": null, "value": "0.92", "disabled": false } ], "referenceLink": [ { "id": null, "value": "https://huggingface.co/timm/mobilenetv3_small_100.lamb_in1k", "disabled": false } ], "demographicParityDifference": [ { "id": null, "value": "0.05", "disabled": false } ], "limitations": [ { "id": null, "value": "Requires high computational resources and may have latency issues for real-time processing", "disabled": false } ] } } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "OAUTH2": [ "object-manager", "object-manager-write", "integration" ] } ] } } }, "components": { "schemas": { "AttributeValueInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the attribute.", "type": "string", "format": "uuid", "example": "a34ccec7-1ec0-4d65-9075-bdd0d923f1d1" }, "value": { "description": "The name of the attribute.", "type": "string", "example": "Text Value" }, "valueKey": { "description": "The name key of the attribute used for translation purposes.", "type": "string", "example": "attribute.option.valueKey" }, "colorCode": { "description": "The color code associated with the attribute.", "type": "string", "example": "red" }, "optionSelectionValue": { "description": "The selection value of the attribute.", "type": "string", "example": 3.5 }, "displayLabel": { "description": "The display label for the attribute.", "type": "string", "example": "United State | San Francisco" }, "disabled": { "description": "This flag indicates whether the attribute is disabled.", "type": "boolean", "example": false, "default": "false" } }, "required": [ "value" ] }, "EntityOrganizationInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the organization.", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46" }, "name": { "description": "The name of the organization.", "type": "string", "example": "Business Unit" } }, "required": [ "id" ] }, "BasicEntityTypeInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the object type.", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46" }, "name": { "description": "The name of the object type.", "type": "string", "example": "Vendor" }, "seeded": { "description": "This flag indicates whether the object type is seeded. ", "type": "boolean", "example": true }, "moduleName": { "description": "The name of the product where the object type exists.", "type": "string", "example": "Vendor", "enum": [ "Vendor", "DataMapping", "Risk", "Assessments", "CustomEntityManagement" ] }, "schemaName": { "description": "The name of the schema.", "type": "string", "example": "vendor", "enum": [ "vendor", "data-mapping", "risk", "assessments", "customEntityManagement" ] } }, "example": "{\n \"id\": \"f2229953-b4b5-4042-8cb9-b78038cc4c46\",\n \"name\": \"Vendor\",\n \"nameKey\": \"EntityType.Vendor.Name\",\n \"seeded\": true,\n \"moduleName\": \"Vendor\",\n \"schemaName\": \"vendor\"\n},\n", "required": [ "id", "name" ] }, "EntityBasicUserInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the user who last modified the record.", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46" }, "name": { "description": "The name of the user who last modified the record.", "type": "string", "example": "First Last" }, "email": { "description": "The email address of the user who last modified the record.", "type": "string", "example": "user@gmail.com" }, "initials": { "description": "The initials of the user who last modified the record.", "type": "string", "example": "FL" } } }, "EntityInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the object.", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46", "readOnly": true }, "number": { "description": "The sequential order in which the object was created.", "type": "integer", "format": "int64", "example": 1, "maximum": 9999999, "minimum": 1, "readOnly": true }, "name": { "description": "The name of the object.", "type": "string", "example": "OneTrust", "maxLength": 255, "minLength": 1 }, "orgGroupId": { "description": "The unique identifier of the organization responsible for the object.", "type": "string", "format": "uuid", "example": "d1119953-b4b5-4042-8cb9-b78038cc2c46" }, "schemaId": { "description": "The unique identifier of the schema.", "type": "string", "format": "uuid", "example": "c21319953-b4b5-4042-8cb9-b78038cc4c51", "readOnly": true }, "entityType": { "description": "The details of the object type.", "example": { "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46", "name": "Asset" }, "$ref": "#/components/schemas/BasicEntityTypeInformation" }, "workflowAndStage": { "description": "The details of the workflow and stage.", "example": { "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84", "name": "Vendor On-Boarding Workflow", "nameKey": "Workflow.VendorOnBoarding.Name", "type": "Vendor", "workflowMode": "BASIC", "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6", "stageName": "Start On-Boarding", "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding", "badgeColor": "#4287f5" }, "$ref": "#/components/schemas/EntityWorkflowInformation" }, "attributes": { "description": "The details of the associated attributes.", "type": "object", "example": { "textAttributeName": [ { "value": "Text" } ], "optionBasedAttributeName": [ { "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46" } ] }, "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeValueInformation" } } }, "auditFields": { "description": "The activity details of when the record was created and last updated.", "example": { "createdBy": "admin@example.com", "createdTimestamp": "2023-01-15T10:30:45Z", "lastModifiedBy": "system@example.com", "lastModifiedTimestamp": "2025-03-22T14:15:22Z" }, "$ref": "#/components/schemas/EntityRecordAuditInformation", "readOnly": true } }, "example": { "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46", "name": "OneTrust", "entityType": { "id": "d1119953-b4b5-4042-8cb9-b78038cc2c46", "name": "Vendor" } }, "required": [ "entityType", "id", "name", "number", "schemaId" ], "title": "Entity Information" }, "EntityRecordAuditInformation": { "type": "object", "properties": { "createdDate": { "description": "The date and time that the record was created.", "type": "string", "format": "date-time", "example": "2021-05-13T13:06:49.853Z" }, "lastUpdatedDate": { "description": "The date and time that the record was last updated.", "type": "string", "format": "date-time", "example": "2021-05-13T13:06:49.853Z" }, "createdBy": { "description": "The creation details of the record.", "example": { "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51", "name": "Name" }, "$ref": "#/components/schemas/EntityBasicUserInformation" }, "lastModifiedBy": { "description": "The last modified details of the record.", "example": { "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51", "name": "Name" }, "$ref": "#/components/schemas/EntityBasicUserInformation" } }, "required": [ "createdDate" ] }, "EntityWorkflowInformation": { "type": "object", "properties": { "id": { "description": "The unique identifier of the workflow.", "type": "string", "format": "uuid", "example": "b271c01a-89a9-41b1-8185-0a3e2bfdad84" }, "name": { "description": "The name of the workflow.", "type": "string", "example": "Vendor On-Boarding Workflow" }, "type": { "description": "The type of workflow.", "type": "string", "example": "Vendor" }, "workflowMode": { "description": "The mode in which the workflow was created.", "type": "string", "example": "BASIC", "enum": [ "ADVANCED, BASIC" ] }, "stageId": { "description": "The unique identifier of the workflow stage.", "type": "string", "format": "uuid", "example": "9fc111cb-c379-4f08-8aff-5be954c1a6e6" }, "stageName": { "description": "The name of the workflow stage.", "type": "string", "example": "Start On-Boarding" } }, "example": { "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84", "name": "Vendor On-Boarding Workflow", "nameKey": "Workflow.VendorOnBoarding.Name", "type": "Vendor", "workflowMode": "BASIC", "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6", "stageName": "Start On-Boarding", "stageNameKey": "Workflow.VendorOnBoarding.Stage.StartOnBoarding", "badgeColor": "#4287f5" }, "required": [ "id", "name", "stageId", "stageName", "type" ] }, "EntityDetailRequest": { "type": "object", "properties": { "extendedBaseAttributes": { "description": "The details of the attribute.", "type": "object", "example": { "textAttributeName": [ { "value": "Text" } ], "optionBasedAttributeName": [ { "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46" } ] }, "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeValueInformation" } } } } }, "ModelCreateRequest": { "type": "object", "properties": { "name": { "description": "The name of the object.", "type": "string", "example": "Customer Sentiment Analysis Model", "maxLength": 255, "minLength": 3, "title": "Model Name" }, "description": { "description": "The description of the object.", "type": "string", "example": "Deep learning model for analyzing customer feedback sentiment", "maxLength": 1000, "title": "Model Description" }, "modelVersion": { "description": "The version of the model.", "type": "string", "example": "2.3.1", "pattern": "^\\d+\\.\\d+\\.\\d+$", "title": "Model Version" }, "limitations": { "description": "The limitations of the model.", "type": "string", "example": "Limited accuracy for non-English languages and specialized industry terminology", "maxLength": 2000, "title": "Model Limitations" }, "biases": { "description": "The known biases of the model.", "type": "string", "example": "May have cultural bias based on training data predominantly from North American customers", "maxLength": 2000, "title": "Model Biases" }, "demographicParityDifference": { "description": "The demographic parity difference measurement.", "type": "string", "format": "decimal", "example": 0.05, "title": "Demographic Parity Difference" }, "demographicParityRatio": { "description": "The demographic parity ratio measurement.", "type": "string", "format": "decimal", "example": 0.92, "title": "Demographic Parity Ratio" }, "equalizedOddsDifference": { "description": "The equalized odds difference measurement.", "type": "string", "format": "decimal", "example": 0.07, "title": "Equalized Odds Difference" }, "equalizedOddsRatio": { "description": "The equalized odds ratio measurement.", "type": "string", "format": "decimal", "example": 0.89, "title": "Equalized Odds Ratio" }, "referenceLink": { "description": "The reference link or other URL.", "type": "string", "format": "uri", "example": "https://example.com/model-docs/sentiment-analysis", "maxLength": 2048, "title": "Reference Link" }, "hubReferenceId": { "description": "The hub reference identifier to cross-reference model repositories.", "type": "string", "example": "SA-MODEL-2025-001", "maxLength": 100, "title": "Hub Reference ID" }, "modelSource": { "description": "The source of the model.", "type": "string", "example": "Internal Development", "default": "Internal Development", "enum": [ "Internal Development", "Vendor", "Open Source", "Third Party" ], "title": "Model Source" }, "additionalAttributes": { "description": "This parameter can be used to store attribute details in key value pairs.", "type": "object", "example": { "algorithm": [ { "stringValue": "BERT" } ], "accuracy": [ { "doubleValue": 0.95 } ], "f1Score": [ { "doubleValue": 0.93 } ] }, "additionalProperties": true, "title": "Additional Attributes" }, "entityDetail": { "description": "The details of the object.", "example": { "extendedBaseAttributes": { "location": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "value": "New York", "displayValue": "New York" } ], "certifications": [ { "value": "AWS Certified Solutions Architect" } ] }, "nameKey": "OneTrust.CM.ModelNameKey" }, "$ref": "#/components/schemas/EntityDetailRequest", "additionalProperties": true, "title": "Entity Details" }, "orgGroupId": { "description": "The unique identifier of the organization responsible for the object.", "format": "uuid", "example": { "id": "f8e7d6c5-b4a3-2019-8765-432109876543", "name": "Parent Org" }, "$ref": "#/components/schemas/EntityOrganizationInformation", "title": "Organization Group ID" } }, "example": { "name": "Customer Sentiment Analysis Model", "description": "Model for analyzing customer feedback sentiment", "modelVersion": "1.0.0", "limitations": "Limited accuracy for non-English languages", "biases": "May have cultural bias based on training data", "modelSource": "Internal Development", "referenceLink": "https://docs.example.com/models/sentiment-analysis" }, "required": [ "name" ], "title": "Model Creation Request" } }, "securitySchemes": { "OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "OBJECT_MANAGER": "Grants full access to Object Manager related APIs.", "OBJECT_MANAGER_READ": "Grants read access to Object Manager related APIs", "OBJECT_MANAGER_WRITE": "Grants write access to Object Manager related APIs" } } } } } } } ``` # Sibling pages * [Get Basic Model Object Details](https://developer.onetrust.com/onetrust/reference/findmodelbasicdetailsbyquerycriteriausingpost.md) * [Get Model Object Details](https://developer.onetrust.com/onetrust/reference/findmodelsbylistcriteriausingpost.md) * [Get Model Object](https://developer.onetrust.com/onetrust/reference/getmodelusingget.md) * [Modify Model Object](https://developer.onetrust.com/onetrust/reference/updatemodelusingput.md) * [Delete Model Object](https://developer.onetrust.com/onetrust/reference/deletemodelusingdelete.md)