API Documentation
← All tools
GET/api/v1/supply-chain/walk

Walk

supply-chainAvailable on FreeNo success wrapper

Traverses the supply-chain graph from one or more starting nodes along the given edge types and returns the reached records plus a boundary and metadata. Call it to explore upstream or downstream relationships (suppliers, customers, dependencies) from known entities. Returns 400 when start or edges is empty or parameters are invalid, and 500 on internal failure.

When to use it

  • Trace upstream suppliers from a company
  • Explore downstream customers from a product
  • Find multi-hop dependencies between entities

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
hydratebooleanNobooleans arrive as strings - send 'true' or 'false'; value is parsed from the raw query string and coerced server-side
limitintegerNoRange 1-50000; default 10000 (range 1-50000; default 10000)
Range: 1 to 50000

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/supply-chain/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