Detect Patterns (Experimental)

{
  "metadata": {
    "edges_analyzed": 1,
    "elapsed_ms": 1,
    "nodes_analyzed": 1
  },
  "nodes": [
    {
      "created_at": "string",
      "name": "string",
      "summary": "string",
      "uuid": "string",
      "attributes": {},
      "degree": 12,
      "episodes": [
        "string"
      ],
      "episodes_truncated": true,
      "labels": [
        "string"
      ],
      "relevance": 1.1,
      "score": 1.1,
      "selection_rank": 1
    }
  ],
  "patterns": [
    {
      "description": "string",
      "edge_types": [
        "string"
      ],
      "edges": [
        {
          "created_at": "string",
          "fact": "string",
          "name": "string",
          "source_node_uuid": "string",
          "target_node_uuid": "string",
          "uuid": "string",
          "attributes": {},
          "episodes": [
            "string"
          ],
          "expired_at": "string",
          "hyperedge_uuid": "string",
          "invalid_at": "string",
          "relevance": 1.1,
          "scope": "string",
          "score": 1.1,
          "selection_rank": 1,
          "source_node_labels": [
            "string"
          ],
          "source_node_name": "string",
          "target_node_labels": [
            "string"
          ],
          "target_node_name": "string",
          "valid_at": "string"
        }
      ],
      "node_labels": [
        "string"
      ],
      "occurrences": 1,
      "summary": "string",
      "type": "string",
      "weighted_score": 1.1
    }
  ]
}

Deprecated. Pattern detection is not part of Public API v4. Detects structural patterns in a knowledge graph including relationship frequencies, multi-hop paths, co-occurrences, hubs, and clusters. When a query is provided, uses hybrid search to discover seed nodes, detects triple-frequency patterns, and returns resolved edges ranked by relevance.

Request

Pattern detection request

detectobjectOptional

Which pattern types to detect with type-specific configuration. Omit to detect all types with defaults. Ignored when query is set.

edge_limitintegerOptional1-100

Max resolved edges per pattern. Default: 10, Max: 100. Only used with query.

graph_idstringOptional

Graph ID when detecting patterns on a named graph

limitintegerOptional1-200

Max patterns to return. Default: 50, Max: 200

min_occurrencesintegerOptional>=1

Minimum occurrence count to report a pattern. Default: 2

querystringOptional1-400 characters

Search query for discovering seed nodes via hybrid search. When set, forces triple-frequency detection only and enables edge resolution with cross-encoder reranking. Mutually exclusive with seeds.

query_limitintegerOptional1-50

Max seed nodes from search. Default: 10, Max: 50. Only used with query.

recency_weightenumOptional

Exponential half-life decay applied to edge created_at timestamps. Valid values: none, 7_days, 30_days, 90_days. Default: none

Allowed values:

search_filtersobjectOptional

Filters which edges/nodes participate in pattern detection. Reuses the same filter format as the graph.search SDK method.

seedsobjectOptional

Seed selection. If omitted, analyzes the entire graph. Mutually exclusive with query.

user_idstringOptional

User ID when detecting patterns on a user graph

Response headers

X-ExperimentalstringOptional

true

Response

Detected patterns

metadataobjectOptional

Statistics about the detection run

nodeslist of objectsOptional

Resolved nodes referenced by pattern edges (deduplicated). Only populated when query is set.

patternslist of objectsOptional

Detected patterns, sorted by weighted_score descending

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error