CognitiveX Docs
API

POST /api/mind/relationships

Create Relationship

POST /api/mind/relationships

Create Relationship

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

NameInTypeRequiredDescription
X-Org-IDheaderstring | nullNo-

Request body

A JSON request body is required.

FieldTypeRequiredDescription
source_idstringYes-
target_idstringYes-
relationship_typestringNoDefaults to "user_link".
weightnumberNoDefaults to 0.72.
notestring | nullNo-

Example request

curl -X POST https://api.cognitivx.io/api/mind/relationships \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "target_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "relationship_type": "user_link",
    "weight": 0.72,
    "note": null
  }'

Example response

200 application/json

{}

Responses

StatusDescription
200Success. Returns the response body shown below.
422Request validation failed. detail lists each offending field.