---
title: "Typed edges and direct neighbours"
method: GET
path: "/v1/entities/{id}/connections"
tags: ["Entities"]
---

# Typed edges and direct neighbours

`GET /v1/entities/{id}/connections`

## Request

- Base URL: `https://brain.inite.ai`
- URL: `https://brain.inite.ai/v1/entities/{id}/connections`
- Auth: HTTP bearer

The entity’s 1-hop neighbourhood over `knowledge_edge`, in both directions (`direction` says which). `kind` filters to one edge type; `asOf` restricts to edges live at that instant. `neighbour` is absent when the far end could not be projected. Edges carry the per-user scope of the turn that wrote them (migration 0153): without `userId` the read is tenant-global only; with one it adds that user’s own edges and neighbours. Honoured while READ_SURFACE_USER_SCOPE is on; a user-bound token is pinned to its own end user, and a mismatch is 403.

Required scope: `brain:read`.

## Path parameters

- `id` string, required

## Query parameters

- `kind` string
- `asOf` string
- `userId` string

## Response `200`

The typed edges.

- EntityConnectionsResponse
  - `edges` ConnectionEdge[], required
    - `createdAt` string, required
    - `direction` 'outbound' | 'inbound', required
    - `edgeId` string, required
    - `from` string, required
    - `kind` string, required
    - `neighbour` ConnectionNeighbour
      - `canonicalName` string, required
      - `id` string, required
      - `type` string, required
    - `source` unknown, required
    - `to` string, required
    - `weight` number, required
  - `entityId` string, required

## Other responses

- `400`: Validation failed.
- `401`: Missing or unknown bearer key.
- `403`: The key lacks the required scope.
- `404`: No such resource in this tenant.

---

[API](https://skmtc.dev/inite/apis/inite-brain-platform-api.md) · [All operations](https://skmtc.dev/inite/apis/inite-brain-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inite/apis/inite-brain-platform-api/revisions/c7c3eb5e304b?raw)
