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

Walk

regulatory-approvalsAvailable on FreeNo success wrapper

Traverses the regulatory graph from one or more starting nodes along specified edge types and returns the reached approvals plus a boundary and metadata. Call it to explore connected regulatory entities (e.g. approvals linked to a product or company) across multiple hops. Returns 400 if start or edges is empty, if parameters are invalid, or if a requested edge type is not available; returns 500 on internal failure.

When to use it

  • Explore regulatory entities connected to a starting node
  • Find approvals reachable through specific relationship types
  • Traverse regulatory relationships in a chosen direction

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
hydratebooleanNoDefault false (default false)
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/regulatory/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