Get an Entity's Relations

Authorization

API Key

x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

id*string

Entity public ID (ent_...). A merged-away id transparently resolves to the surviving entity.

Query Parameters

direction?string

Which edges to return relative to the entity. Defaults to both.

Value in"inbound" | "outbound" | "both"

relationType?string

Exact-match filter on the relation label.

limit?integer

Maximum number of edges to return (default 50, max 200).

Formatint32

cursor?string

Cursor: return edges whose KSUID sorts after this value.

bucket?string

Optional bucket public ID (bkt_...) to scope the read to one bucket. Omit for the unscoped (all account+environment) view.

Response Body

`application/json`

curl -X GET "https://api.bem.ai/v3/entities/string/relations"

{
  "inbound": [
    {
      "relationType": "string",
      "sourceEntity": {
        "id": "string",
        "canonical": "string",
        "type": "string"
      },
      "mentionCount": 0,
      "firstSeenAt": "2019-08-24T14:15:22Z"
    }
  ],
  "outbound": [
    {
      "relationType": "string",
      "targetEntity": {
        "id": "string",
        "canonical": "string",
        "type": "string"
      },
      "mentionCount": 0,
      "firstSeenAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}