Properties
| Name | Type | Description |
|---|---|---|
| data | object | The relationship definition to create. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/clarify/main/json-schema/clarify-create-relationship-dto-schema.json",
"title": "CreateRelationshipDto",
"x-generated": "2026-10-08",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/clarify-openapi.json#/components/schemas/CreateRelationshipDto",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"relationship"
],
"description": "The JSON:API resource type."
},
"attributes": {
"description": "Relationship fields keyed first by object type, then by field name. Both sides of each relationship must be supplied together.",
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "The display name of the relationship field."
},
"xClarifyPresentation": {
"type": "object",
"properties": {
"rank": {
"type": "number",
"description": "The sort position of the field relative to its siblings."
}
},
"required": [
"rank"
],
"additionalProperties": false,
"description": "Presentation metadata controlling how the field is displayed."
},
"xClarifyAIField": {
"type": "object",
"properties": {
"prompt": {
"type": "array",
"items": {},
"description": "The prompt that instructs the AI how to compute the field, as rich-text content blocks."
},
"isInternetSearchEnabled": {
"type": "boolean",
"description": "Whether the AI may search the internet while computing the field."
},
"model": {
"type": "string",
"enum": [
"fast",
"smart"
],
"description": "The AI model used to compute the field."
},
"runOnCreate": {
"type": "boolean",
"description": "Deprecated. Whether the field is computed when a record is created."
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plugin_id": {
"type": "string",
"minLength": 1,
"description": "The plugin that defines the trigger event."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1,
"description": "The field whose value the trigger condition is evaluated on."
},
"condition": {
"type": "object",
"additionalProperties": {},
"description": "The condition the field value must satisfy for the trigger to fire."
}
},
"required": [
"field",
"condition"
],
"additionalProperties": false
},
"description": "Conditions that must all pass for the trigger to fire."
},
"input": {
"type": "object",
"additionalProperties": {},
"description": "The trigger’s configuration, keyed by input name."
}
},
"required": [
"plugin_id",
"filters",
"input"
],
"additionalProperties": false
},
"description": "The events that cause the AI field to be recomputed."
}
},
"required": [
"prompt",
"isInternetSearchEnabled",
"model"
],
"additionalProperties": false,
"description": "AI configuration for an AI-generated relationship field, if the relationship is computed."
},
"type": {
"description": "The JSON Schema type of a many-to-one relationship field: a nullable string holding the related record ID."
},
"xClarifyRelationship": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"many-to-one"
],
"description": "Fixed to `many-to-one` for this variant."
},
"entity": {
"type": "string",
"minLength": 1,
"description": "The object type this relationship points to, e.g. `company`."
},
"field": {
"type": "string",
"minLength": 1,
"description": "The name of the counterpart field on the related object."
},
"mergeable": {
"type": "boolean",
"description": "Whether values on this relationship are combined when two records are merged."
},
"aiFieldTraversable": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"atDepth": {
"type": "number",
"enum": [
1,
2
],
"description": "The relationship-hop depth (1 or 2) at which AI fields may traverse this relationship."
}
},
"required": [
"atDepth"
],
"description": "Traversal allowed only up to the given relationship depth."
}
],
"description": "Whether AI fields may traverse this relationship to read the related record’s data; either a boolean or a depth-limited object."
},
"labelFromEntity": {
"type": "boolean",
"description": "Whether the field title is derived from the related object’s current name instead of the stored title."
}
},
"required": [
"kind",
"entity",
"field"
],
"additionalProperties": false,
"description": "The relationship metadata for this many-to-one field."
}
},
"required": [
"title",
"type",
"xClarifyRelationship"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "The display name of the relationship field."
},
"xClarifyPresentation": {
"type": "object",
"properties": {
"rank": {
"type": "number",
"description": "The sort position of the field relative to its siblings."
}
},
"required": [
"rank"
],
"additionalProperties": false,
"description": "Presentation metadata controlling how the field is displayed."
},
"xClarifyAIField": {
"type": "object",
"properties": {
"prompt": {
"type": "array",
"items": {},
"description": "The prompt that instructs the AI how to compute the field, as rich-text content blocks."
},
"isInternetSearchEnabled": {
"type": "boolean",
"description": "Whether the AI may search the internet while computing the field."
},
"model": {
"type": "string",
"enum": [
"fast",
"smart"
],
"description": "The AI model used to compute the field."
},
"runOnCreate": {
"type": "boolean",
"description": "Deprecated. Whether the field is computed when a record is created."
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plugin_id": {
"type": "string",
"minLength": 1,
"description": "The plugin that defines the trigger event."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1,
"description": "The field whose value the trigger condition is evaluated on."
},
"condition": {
"type": "object",
"additionalProperties": {},
"description": "The condition the field value must satisfy for the trigger to fire."
}
},
"required": [
"field",
"condition"
],
"additionalProperties": false
},
"description": "Conditions that must all pass for the trigger to fire."
},
"input": {
"type": "object",
"additionalProperties": {},
"description": "The trigger’s configuration, keyed by input name."
}
},
"required": [
"plugin_id",
"filters",
"input"
],
"additionalProperties": false
},
"description": "The events that cause the AI field to be recomputed."
}
},
"required": [
"prompt",
"isInternetSearchEnabled",
"model"
],
"additionalProperties": false,
"description": "AI configuration for an AI-generated relationship field, if the relationship is computed."
},
"oneOf": {
"description": "The JSON Schema type of a one-to-many relationship field: a nullable collection of related record IDs."
},
"xClarifyRelationship": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"one-to-many"
],
"description": "Fixed to `one-to-many` for this variant."
},
"entity": {
"type": "string",
"minLength": 1,
"description": "The object type this relationship points to, e.g. `company`."
},
"field": {
"type": "string",
"minLength": 1,
"description": "The name of the counterpart field on the related object."
},
"mergeable": {
"type": "boolean",
"description": "Whether values on this relationship are combined when two records are merged."
},
"aiFieldTraversable": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"atDepth": {
"type": "number",
"enum": [
1,
2
],
"description": "The relationship-hop depth (1 or 2) at which AI fields may traverse this relationship."
}
},
"required": [
"atDepth"
],
"description": "Traversal allowed only up to the given relationship depth."
}
],
"description": "Whether AI fields may traverse this relationship to read the related record’s data; either a boolean or a depth-limited object."
},
"labelFromEntity": {
"type": "boolean",
"description": "Whether the field title is derived from the related object’s current name instead of the stored title."
}
},
"required": [
"kind",
"entity",
"field"
],
"additionalProperties": false,
"description": "The relationship metadata for this one-to-many field."
}
},
"required": [
"title",
"oneOf",
"xClarifyRelationship"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "The display name of the relationship field."
},
"xClarifyPresentation": {
"type": "object",
"properties": {
"rank": {
"type": "number",
"description": "The sort position of the field relative to its siblings."
}
},
"required": [
"rank"
],
"additionalProperties": false,
"description": "Presentation metadata controlling how the field is displayed."
},
"xClarifyAIField": {
"type": "object",
"properties": {
"prompt": {
"type": "array",
"items": {},
"description": "The prompt that instructs the AI how to compute the field, as rich-text content blocks."
},
"isInternetSearchEnabled": {
"type": "boolean",
"description": "Whether the AI may search the internet while computing the field."
},
"model": {
"type": "string",
"enum": [
"fast",
"smart"
],
"description": "The AI model used to compute the field."
},
"runOnCreate": {
"type": "boolean",
"description": "Deprecated. Whether the field is computed when a record is created."
},
"triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plugin_id": {
"type": "string",
"minLength": 1,
"description": "The plugin that defines the trigger event."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"minLength": 1,
"description": "The field whose value the trigger condition is evaluated on."
},
"condition": {
"type": "object",
"additionalProperties": {},
"description": "The condition the field value must satisfy for the trigger to fire."
}
},
"required": [
"field",
"condition"
],
"additionalProperties": false
},
"description": "Conditions that must all pass for the trigger to fire."
},
"input": {
"type": "object",
"additionalProperties": {},
"description": "The trigger’s configuration, keyed by input name."
}
},
"required": [
"plugin_id",
"filters",
"input"
],
"additionalProperties": false
},
"description": "The events that cause the AI field to be recomputed."
}
},
"required": [
"prompt",
"isInternetSearchEnabled",
"model"
],
"additionalProperties": false,
"description": "AI configuration for an AI-generated relationship field, if the relationship is computed."
},
"oneOf": {
"description": "The JSON Schema type of a many-to-many relationship field: a nullable collection of related record IDs."
},
"xClarifyRelationship": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"many-to-many"
],
"description": "Fixed to `many-to-many` for this variant."
},
"entity": {
"type": "string",
"minLength": 1,
"description": "The object type this relationship points to, e.g. `company`."
},
"field": {
"type": "string",
"minLength": 1,
"description": "The name of the counterpart field on the related object."
},
"mergeable": {
"type": "boolean",
"description": "Whether values on this relationship are combined when two records are merged."
},
"aiFieldTraversable": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "object",
"properties": {
"atDepth": {
"type": "number",
"enum": [
1,
2
],
"description": "The relationship-hop depth (1 or 2) at which AI fields may traverse this relationship."
}
},
"required": [
"atDepth"
],
"description": "Traversal allowed only up to the given relationship depth."
}
],
"description": "Whether AI fields may traverse this relationship to read the related record’s data; either a boolean or a depth-limited object."
},
"labelFromEntity": {
"type": "boolean",
"description": "Whether the field title is derived from the related object’s current name instead of the stored title."
}
},
"required": [
"kind",
"entity",
"field"
],
"additionalProperties": false,
"description": "The relationship metadata for this many-to-many field."
}
},
"required": [
"title",
"oneOf",
"xClarifyRelationship"
],
"additionalProperties": false
}
]
}
}
}
},
"required": [
"type",
"attributes"
],
"additionalProperties": false,
"description": "The relationship definition to create."
}
},
"required": [
"data"
],
"additionalProperties": false
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/clarify-create-relationship-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.