/api/v1/virhostnet/walkWalk
Returns the boundary of a graph traversal starting from one or more nodes and following the given edge types, with traversal metadata. Call it to explore which nodes are reachable from a starting set within a hop range and direction. Fails with 400 when start or edges is empty, when query parameters are invalid, or when a requested edge type is not available; 500 on internal error.
When to use it
- Explore reachable nodes from a set of starting nodes
- Find neighbors of a virus or host across selected relationship types
- Traverse relationships in a chosen direction within a hop range
Getting started
Base URL
https://app.caelrith.com/api/v1/toolsAuthentication
Include your API key in the x-api-key header.
Rate limit
Every call counts against your workspace’s daily quota for biology-associations. Exceeding it returns HTTP 429.
Plans and daily limits
| Plan | Available | Calls / day |
|---|---|---|
| free | yes | 10 |
| pro | yes | 200 |
| custom (default) | yes | 10,000 |
Plan defaults. A custom workspace may carry per-tenant overrides.
Parameters
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| start | string (comma-separated) | Yes | [comma-separated list] minimum length 1 |
| edges | string (comma-separated) | Yes | [comma-separated list] minimum length 1 |
| direction | string | No | Default out (default out) Allowed values: out, in, both |
| min_hops | integer | No | Range 0-64; default 1 (range 0-64; default 1) Range: 0 to 64 |
| max_hops | integer | No | Range 0-64; default 3 (range 0-64; default 3) Range: 0 to 64 |
| limit | integer | No | Range 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/virhostnet/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