Get knowledge graph

{ "nodes": [ { "id": "12345", "name": "John Smith", "type": "person", "definition_slug": "person", "primary_attribute": "<string>", "created_at": "2023-11-07T05:31:56Z" } ], "edges": [ { "id": "<string>", "source": "<string>", "target": "<string>", "label": "works_at", "definition_id": "<string>" } ], "relationship_definitions": [ { "id": "<string>", "name": "<string>", "entity_1_to_2": "<string>", "entity_2_to_1": "<string>" } ], "context_edges": [ { "id": "tri_42", "source": "12345", "target": "67890", "label": "works_with", "edge_type": "context", "confidence": 0.5 } ], "insight_nodes": [ { "id": "ei:42", "content": "John prefers email communication over phone calls", "type": "preference", "confidence": 0.5, "source": "entity_insight" } ], "insights": {}, "total_nodes": 123, "total_edges": 123, "total_context_edges": 123 }

Authorizations

Authorization

string

header

required

API key for authentication (format: "Bearer YOUR_API_KEY")

Query Parameters

limit

integer

default:1000

Maximum number of entity nodes to return

Required range: 1 <= x <= 5000

format

enum<string>

Response format. Use html to receive an interactive graph visualization instead of JSON.

Available options:

json,

html

Response

Knowledge graph data

Complete knowledge graph for the workspace

nodes

object[]

CRM entity nodes (people, companies, custom objects) and ghost nodes (entities mentioned in context but not yet resolved to a CRM record)

Hide child attributes

nodes.id

string

Node ID. CRM entities use numeric IDs (e.g., "12345"). Ghost nodes use the format "ghost:<context_id>".

Example:

"12345"

nodes.name

string

Display name (primary attribute value, or a generated name for unnamed entities)

Example:

"John Smith"

nodes.type

string

Entity type name (e.g., "person", "company", "ghost")

Example:

"person"

nodes.definition_slug

string

Slug of the entity definition

Example:

"person"

nodes.primary_attribute

string

Value of the entity's primary attribute

nodes.created_at

string<date-time>

When the entity was created

edges

object[]

CRM relationship edges between entity nodes (e.g., person works_at company)

Hide child attributes

edges.id

string

Edge ID

edges.source

string

Source node ID

edges.target

string

Target node ID

edges.label

string

Relationship label (e.g., "works_at", "reports_to")

Example:

"works_at"

edges.definition_id

string

ID of the relationship definition

relationship_definitions

object[]

Definitions of relationship types in the workspace

Hide child attributes

relationship_definitions.id

string

Definition ID

relationship_definitions.name

string

Display name

relationship_definitions.entity_1_to_2

string

Label from entity 1 to entity 2 (e.g., "works_at")

relationship_definitions.entity_2_to_1

string

Inverse label from entity 2 to entity 1 (e.g., "employs")

context_edges

object[]

Edges derived from ingested context, AI-extracted triplets, insight-entity links, and insight-to-insight semantic relationships. Each edge has an edge_type indicating its source.

Hide child attributes

context_edges.id

string

Edge ID. Prefixed by type: "ctx_" for context, "tri_" for triplet, "ei_edge_" for entity insight edges, and "il_" for insight_link edges.

Example:

"tri_42"

context_edges.source

string

Source node ID. Can be an entity ID, ghost ID ("ghost:123"), or insight node ID ("ei:123" or "ki:123").

Example:

"12345"

context_edges.target

string

Target node ID

Example:

"67890"

context_edges.label

string

Edge label. For context edges: the relationship type. For triplets: the predicate (e.g., "works_with"). For insight edges: the insight type. For insight_link edges: "related_to" or "contradicts".

Example:

"works_with"

context_edges.edge_type

enum<string>

Source type of the edge

Available options:

context,

triplet,

insight,

insight_link

context_edges.confidence

number<double> | null

Confidence score (0-1). Present on triplet edges (extraction confidence) and insight_link edges (similarity score). Null/absent for context and insight edges.

Required range: 0 <= x <= 1

insight_nodes

object[]

Insight nodes representing AI-extracted knowledge (entity insights and workspace-level knowledge insights)

Hide child attributes

insight_nodes.id

string

Insight node ID. Entity insights use "ei:", knowledge insights use "ki:".

Example:

"ei:42"

insight_nodes.content

string

The insight text content

Example:

"John prefers email communication over phone calls"

insight_nodes.type

string

Insight type (e.g., "preference", "behavior", "fact")

Example:

"preference"

insight_nodes.confidence

number<double>

Confidence score (0-1)

Required range: 0 <= x <= 1

insight_nodes.source

enum<string>

Source type: "entity_insight" (scoped to an entity) or "knowledge_insight" (workspace-level)

Available options:

entity_insight,

knowledge_insight

insights

object

Per-entity insight summaries, keyed by entity ID

Hide child attributes

insights.{key}

object[]

Hide child attributes

insights.{key}.content

string

The insight text content

insights.{key}.confidence

number<double>

Confidence score (0-1)

Required range: 0 <= x <= 1

insights.{key}.type

string

Insight type

total_nodes

integer

Total number of entity nodes in the workspace (may exceed the returned count due to the limit parameter)

total_edges

integer

Total number of CRM relationship edges in the workspace

total_context_edges

integer

Total number of context edges returned (includes all edge types)

API Documentation

Schema

Objects

Records

Relationships

Lists

Tasks

Notes

Timeline

Search

Context

Insights

Graph

Integrations

Notifications

AI Lists

Compounding

Lists

Objects

Schema

Records

Context

AI Lists

Relationships

Timeline

Tasks

Notes

Insights

Search

Graph

Integrations

Compounding

Notifications

Get knowledge graph

Authorizations

Query Parameters

Response

API Documentation

Schema

Objects

Records

Relationships

Lists

Tasks

Notes

Timeline

Search

Context

Insights

Graph

Integrations

Notifications

AI Lists

Compounding

Lists

Objects

Schema

Records

Context

AI Lists

Relationships

Timeline

Tasks

Notes

Insights

Search

Graph

Integrations

Compounding

Notifications

Documentation Index

Authorizations

Query Parameters

Response