read_graph

read_graph

• Category: knowledge
• Access: read
• Audience: ordinary (an ordinary user normally calls this directly)

Purpose

Reads the visible knowledge graph as a paged snapshot: entities with their observations plus the relations between them. The broad orientation read when exploring what is known.

Arguments

Optional: limit, offset.

• limit. Note: Page size (default 500).
• offset. Note: Starting position in name order.

Result

JSON object with entities (name, entityType, project which is always present and null when unset, observations), relations (from, to, relationType), total (visible live entity count), and has_more.

Boundaries

Only live entities and relations visible under the caller's project grants are included; both relation endpoints must be visible. No visible scope reads as an empty snapshot with total 0, never a denial.

Lifecycle / side effects

Pure read of live content; retired entries resolve as absent. A best-effort access note is recorded alongside the read and never affects the returned content.

Errors

Unknown arguments and bad types are rejected (strict validator).

Example

{
  "limit": 10,
  "offset": 0
}

Result shape:

{
  "entities": [
    {
      "entityType": "vendor",
      "name": "Acme Print",
      "observations": [
        "Local print shop on High Street."
      ],
      "project": "shared-ops"
    }
  ],
  "has_more": false,
  "relations": [],
  "total": 1
}

See also

open_nodes, search_nodes, search_by_project, find_by_title.