x-cpod-domain: graph
Graph
Nodes, edges, and queries for graph-based data modeling.
Try in explorer
client.graphNode
A graph node with a type label and arbitrary properties.
REST path
/api/v1/graph/nodesOperations
listgetcreateupdatedeleteSDK
// 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: {},
})| Field | Type | Description |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App 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-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | Where the write originated. Defaults to 'api'.frontendbackendserversystemapi |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| type* | string | Node type label (e.g., person, project, document). |
| properties* | json | Key-value properties attached to the node. |
| tags | json | Free-form tags for filtering. |
Edge
A directed graph edge between two nodes.
REST path
/api/v1/graph/edgesOperations
listgetcreateupdatedeleteSDK
// 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",
})| Field | Type | Description |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App 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-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | Where the write originated. Defaults to 'api'.frontendbackendserversystemapi |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| source_id* | string | Source node ID. |
| target_id* | string | Target node ID. |
| type* | string | Edge type label (e.g., reports_to, owns, member_of). |
| properties | json | Key-value properties attached to the edge. |
| weight | number | Edge weight for weighted graph algorithms. |
| target_type | string | Entity type name of the target entity (e.g., Person, TechnologyAsset). |
| relationship_type | string | Semantic label describing the nature of this relationship (e.g., manages, owns, depends_on). |
| confidence | number | Confidence 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/queriesOperations
listgetcreateupdatedeleteSDK
// 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",
})| Field | Type | Description |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App 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-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | Where the write originated. Defaults to 'api'.frontendbackendserversystemapi |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name* | string | Human-readable query name. |
| query* | string | Query text in the specified language. |
| language* | enum | Query language.cyphergremlinsparql |
| description | string | Traversal query to find all reporting relationships. |
| owner_id | string | User ID of the query owner. |
| tags | json | Free-form tags for filtering. |