API Documentation
← API overview

Merged

2 endpoints · every section below is generated from the API catalog

GET/api/v1/merged/path

Path

Available on FreeFull reference →

Returns the boundary of a multi-step traversal starting from one or more start nodes, following the requested step sequence. Call it to walk relationships across the merged graph from known starting points. Fails with 400 when start is empty, when steps cannot be parsed, or when required data is not loaded; returns 500 on internal errors.

Rate limit: regulatoryApiCallsPerDay · Free plan: 30/day

Parameters

ParameterTypeRequiredDescription
startstring (comma-separated)Yes[comma-separated list] minimum length 1
stepsstringYesminimum length 1
limitintegerNoRange 1-50000; default 20000 (range 1-50000; default 20000)
Range: 1 to 50000

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/merged/path?start=your_start&steps=your_steps"
GET/api/v1/merged/walk

Walk

Available on FreeFull reference →

Traverses the merged graph from one or more starting nodes across the given edge types and returns the reached boundary nodes plus traversal metadata. Call it to explore relationships outward from known nodes, optionally restricting hop distance and direction. Returns 400 when start or edges is empty, when a parameter is invalid, or when a requested edge type is not loaded; returns 500 on internal failure.

Rate limit: regulatoryApiCallsPerDay · Free plan: 30/day

Parameters

ParameterTypeRequiredDescription
startstring (comma-separated)Yes[comma-separated list] minimum length 1
edgesstring (comma-separated)Yes[comma-separated list] minimum length 1
directionstringNoDefault out (default out)
Allowed values: out, in, both
min_hopsintegerNoRange 0-64; default 1 (range 0-64; default 1)
Range: 0 to 64
max_hopsintegerNoRange 0-64; default 3 (range 0-64; default 3)
Range: 0 to 64
limitintegerNoRange 1-50000; default 20000 (range 1-50000; default 20000)
Range: 1 to 50000

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/merged/walk?start=your_start&edges=your_edges"