API Documentation
← All tools
GET/api/v1/merged/walk

Walk

mergedAvailable on FreeNo success wrapper

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.

When to use it

  • Explore relationships outward from known nodes
  • Find nodes reachable within a hop range across selected edge types
  • Trace incoming or outgoing connections from a set of starting nodes

Getting started

Base URL

https://app.caelrith.com/api/v1/tools

Authentication

Include your API key in the x-api-key header.

Rate limit

Every call counts against your workspace’s daily quota for regulatoryApiCallsPerDay. Exceeding it returns HTTP 429.

Plans and daily limits

PlanAvailableCalls / day
freeyes30
proyes200
custom (default)yes10,000

Plan defaults. A custom workspace may carry per-tenant overrides.

Parameters

Query 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"

Response envelope

This endpoint returns an implicit 2xx response - there is no success flag in the body.

{
  "data": { /* payload */ },
  "meta": { /* pagination, totals */ }
}

// No "success" flag on this endpoint - any 2xx JSON is a success.

Catalog version mcp-2026-10-28 · generated from the live MCP catalog