API Documentation
← API overview

Virhostnet

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

GET/api/v1/virhostnet/factors

Factors

Available on FreeFull reference →

Returns a paginated list of viral/host factors, with each item plus metadata giving the current page, page size, total item count, and total page count. Call it to browse or enumerate factors, optionally narrowed to a single taxonomy. Invalid query parameters return HTTP 400; an unexpected server failure returns HTTP 500.

Rate limit: biology-associations · Free plan: 10/day

Parameters

ParameterTypeRequiredDescription
pageintegerNoMin 1; default 1 (min 1; default 1)
Range: 1 to ∞
limitintegerNoRange 1-100; default 20 (range 1-100; default 20)
Range: 1 to 100
taxidstringNominimum length 1; maximum length 32

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/virhostnet/factors"
GET/api/v1/virhostnet/factors/:key

Details

Available on FreeFull reference →

Returns the details of a single virus-host interaction factor identified by its key. Call it when you already have a factor key and need its full record. Responds 404 if no factor matches the key, and 500 on an internal failure.

Rate limit: biology-associations · Free plan: 10/day

Parameters

ParameterTypeRequiredDescription
key(path)stringYes

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/virhostnet/factors/{key}"
GET/api/v1/virhostnet/targets/:key/interactions

Interactions

Available on FreeFull reference →

Returns the virus-host interactions associated with a single VirHostNet target, identified by its key. Call it to list the interactions recorded for a known target. Responds with 404 when no target matches the key and 500 on an internal failure.

Rate limit: biology-associations · Free plan: 10/day

Parameters

ParameterTypeRequiredDescription
key(path)stringYes

Example request

curl -H "x-api-key: YOUR_API_KEY" \
  "https://app.caelrith.com/api/v1/virhostnet/targets/{key}/interactions"
GET/api/v1/virhostnet/walk

Walk

Available on FreeFull reference →

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.

Rate limit: biology-associations · Free plan: 10/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 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"