---
title: "Create Entity"
method: POST
path: "/api/ai-governance/v1/entities"
tags: ["Entity Management"]
---

# Create Entity

`POST /api/ai-governance/v1/entities`

Use this API to create a new entity record.

> 🗒 Things to Know
> 
> - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
> - AI Governance APIs will become available over the course of the Spring as customer tenants are upgraded to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.

## Query parameters

- `entityTypeId` string, uuid
- `entityTypeName` string

## Request body

- EntityCreateRequest
  - `name` string, required — The name of the entity. Required field used as the primary identifier for users.
  - `organization` EntityOrganizationInformation
    - `id` string, uuid, required — The unique identifier of the organization.
    - `name` string — The name of the organization.
  - `attributes` object — The custom attributes for the entity defined by its schema. Contains attribute paths mapped to their values.
  - `workflowAndStage` EntityWorkflowStageRequest
    - `workflow` BasicAttributeInformation
      - `id` string, uuid — Unique Identifier of an Entity Attribute
      - `value` string — Value of an Entity Attribute
    - `stage` BasicAttributeInformation
      - `id` string, uuid — Unique Identifier of an Entity Attribute
      - `value` string — Value of an Entity Attribute
    - `closedDate` string, date-time — Date when the entity was closed. Only relevant for workflows with closed stages.
  - `entityLinks` BasicLinkCreateSourceRequest[] — Entity link requests to create relationships with other entities during entity creation
    - `attributes` object — Custom attributes for the link based on the link type schema. Contains attribute paths mapped to their values.
    - `entity1` LinkedEntityInformation
      - `linkEntityDetail` EntityDetailRequest
        - `extendedBaseAttributes` object — Base Seeded Attributes
      - `id` string, uuid, required — Unique identifier of the entity
      - `number` integer, required — Auto-generated sequential entity number
      - `name` string — Name of the entity
      - `detailsAccessRestricted` boolean — Flag indicating whether entity is view-only
      - `redirectURL` string — Redirect URL for the entity
      - `entityType` BasicEntityTypeInformation, required
        - `id` string, uuid, required — The unique identifier for the entity type.
        - `name` string, required — The name of the entity type.
        - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
        - `moduleName` string — The name of the module where the entity exists.
        - `schemaName` string — The name of the schema.
      - `deleted` boolean
    - `entity2` LinkedEntityInformation, required
      - `linkEntityDetail` EntityDetailRequest
        - `extendedBaseAttributes` object — Base Seeded Attributes
      - `id` string, uuid, required — Unique identifier of the entity
      - `number` integer, required — Auto-generated sequential entity number
      - `name` string — Name of the entity
      - `detailsAccessRestricted` boolean — Flag indicating whether entity is view-only
      - `redirectURL` string — Redirect URL for the entity
      - `entityType` BasicEntityTypeInformation, required
        - `id` string, uuid, required — The unique identifier for the entity type.
        - `name` string, required — The name of the entity type.
        - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
        - `moduleName` string — The name of the module where the entity exists.
        - `schemaName` string — The name of the schema.
      - `deleted` boolean
    - `entityLinkTypeId` string, uuid — Unique identifier of the link type that defines the relationship. Required if sourceSystemGenerator is not provided.
    - `sourceSystemGenerator` string — Identifier of the system that generates this link. Required if entityLinkTypeId is not provided.
    - `linkTypeLabel` string — Display name for the relationship direction. Used for showing the relationship in UI.

## Response `201`

Created - The entity was successfully created

- EntityInformation
  - `id` string, uuid, required — The unique identifier of the entity.
  - `number` integer, required — The numerical order in which the entity was created.
  - `name` string — The name of the entity.
  - `orgGroupId` string, uuid — The unique identifier of the organization.
  - `schemaId` string, uuid, required — The unique identifier of the schema.
  - `entityType` BasicEntityTypeInformation, required
    - `id` string, uuid, required — The unique identifier for the entity type.
    - `name` string, required — The name of the entity type.
    - `seeded` boolean — This parameter indicates whether the entity type is seeded or custom.
    - `moduleName` string — The name of the module where the entity exists.
    - `schemaName` string — 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' — This parameter indicates whether the workflow mode is null, basic, or advanced.
    - `stageId` string, uuid, required — The unique identifier of the workflow stage.
    - `stageName` string, required — The name of the workflow stage.
  - `attributes` object
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required — The date and time that the entity was last created.
    - `lastUpdatedDate` string, date-time — The date and time that the entity was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.

## 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.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)