Docs

Docs

x-cpod-domain: graph

Graph

Nodes, edges, and queries for graph-based data modeling.

Try in explorer client.graph

Node

A graph node with a type label and arbitrary properties.

REST path/api/v1/graph/nodes
Operations
listgetcreateupdatedelete
SDK
// list — returns only your records; add filters/search:
await client.graph.nodes.list()

// create:
await client.graph.nodes.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  type: "example type",
  properties: {},
})
FieldTypeDescription
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumWhere the write originated. Defaults to 'api'.frontendbackendserversystemapi
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
type*stringNode type label (e.g., person, project, document).
properties*jsonKey-value properties attached to the node.
tagsjsonFree-form tags for filtering.

Edge

A directed graph edge between two nodes.

REST path/api/v1/graph/edges
Operations
listgetcreateupdatedelete
SDK
// list — returns only your records; add filters/search:
await client.graph.edges.list()

// create:
await client.graph.edges.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  source_id: "example source_id",
  target_id: "example target_id",
})
FieldTypeDescription
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumWhere the write originated. Defaults to 'api'.frontendbackendserversystemapi
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
source_id*stringSource node ID.
target_id*stringTarget node ID.
type*stringEdge type label (e.g., reports_to, owns, member_of).
propertiesjsonKey-value properties attached to the edge.
weightnumberEdge weight for weighted graph algorithms.
target_typestringEntity type name of the target entity (e.g., Person, TechnologyAsset).
relationship_typestringSemantic label describing the nature of this relationship (e.g., manages, owns, depends_on).
confidencenumberConfidence score (0.0-1.0) that this relationship is accurate; 1.0 is authoritative.

GraphQuery

A saved graph query in a supported query language.

REST path/api/v1/graph/queries
Operations
listgetcreateupdatedelete
SDK
// list — returns only your records; add filters/search:
await client.graph.queries.list()

// create:
await client.graph.queries.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  name: "example name",
  query: "example query",
})
FieldTypeDescription
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumWhere the write originated. Defaults to 'api'.frontendbackendserversystemapi
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
name*stringHuman-readable query name.
query*stringQuery text in the specified language.
language*enumQuery language.cyphergremlinsparql
descriptionstringTraversal query to find all reporting relationships.
owner_idstringUser ID of the query owner.
tagsjsonFree-form tags for filtering.