Sustema

ENTITY developer reference

GraphBoundary

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

A returned byte_limit boundary means an explicitly bounded partial graph, never complete. Reserve space for the boundary and completeness metadata before admitting another node/edge. If even a truthful boundary cannot fit, return the typed no-delivery error. continuation_supported remains false; no unsupported continuation is implied.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

entity_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for entity_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

reason

Listed in this schema’s required array.

Declared type
"string"
Reading definition for reason
{
  "type": "string",
  "enum": [
    "depth_limit",
    "node_limit",
    "edge_limit",
    "cycle",
    "unsupported",
    "restricted",
    "unresolved_endpoint",
    "stale_endpoint",
    "byte_limit"
  ],
  "x-profile-maxLength": "string_characters_max"
}

path_id

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for path_id
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "entity_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "reason": {
      "type": "string",
      "enum": [
        "depth_limit",
        "node_limit",
        "edge_limit",
        "cycle",
        "unsupported",
        "restricted",
        "unresolved_endpoint",
        "stale_endpoint",
        "byte_limit"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "path_id": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "entity_id",
    "reason",
    "path_id"
  ],
  "additionalProperties": false,
  "description": "A returned byte_limit boundary means an explicitly bounded partial graph, never complete. Reserve space for the boundary and completeness metadata before admitting another node/edge. If even a truthful boundary cannot fit, return the typed no-delivery error. continuation_supported remains false; no unsupported continuation is implied."
}

All API operations