---
title: "Create a new relationship kind definition"
method: POST
path: "/api/rest/v1/relationship-kinds"
tags: ["Relationship Kind Definitions"]
---

# Create a new relationship kind definition

`POST /api/rest/v1/relationship-kinds`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/relationship-kinds`
- Auth: none required

## Request body

- CreateRelationshipKindDefinitionRequest: Create relationship kind definition request body.
  - `key` string, required
  - `displayName` string, required
  - `sourceLabel` string, required
  - `targetLabel` string, required
  - `description` string, nullable
  - `icon` string
  - `color` string
  - `cardinality` string
  - `cyclePolicy` string
  - `deletePolicy` string
  - `isHierarchical` boolean
  - `isDependency` boolean
  - `isApiProvider` boolean

## Response `201`

Created

- RestApiResponseOfRelationshipKindDefinitionItem: Standard REST API response envelope for a single resource.
  - `data` RelationshipKindDefinitionItem, required: Relationship kind definition item for list and single-resource responses.
    - `id` string, uuid, required
    - `key` string, required
    - `displayName` string, required
    - `description` string, nullable, required
    - `icon` string, required
    - `color` string, required
    - `displayOrder` union, required
      - integer
      - string, int32
    - `isHierarchical` boolean, required
    - `isDependency` boolean, required
    - `isApiProvider` boolean, required
    - `cardinality` string, required
    - `cyclePolicy` string, required
    - `deletePolicy` string, required
    - `sourceLabel` string, required
    - `targetLabel` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `429`: Too Many Requests

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)