relationships
Graph lane: labelled relationship EDGES between companies/entities (ownership, operates, supplies,
…) — the PRODUCT (edges with tiers + provenance), named for the capability, not the meter. Typed query
params (GET /relationships): entity (the START NODE — matched as a case-insensitive SUBSTRING of an
entity/company NAME, never an id: "3" matches any name containing "3" and resolves to an arbitrary
one, so pass a full, distinctive name), hops (traversal DEPTH 1-10, default 1 — the BILLING UNIT:
metered per hop, which is why billing_quote takes hops=),
relation_type (one relation label — checked against the API's allow-list; unknown -> backend 400),
search (free-text), limit (<=100, default 50), offset. Metered — debited from the CALLING agent's own
wallet, not the owner's (read it with the joules_balance tool). For the exact per-caller price before
you call, use the billing_quote tool (free, tier-aware; returns joules_all_in) or check
affordability with the joules_deficit tool; the true debit is the base joule_cost plus a 0.5% rail
surcharge rounded up (a 100 J call debits 101 J) = joules_all_in. Preserves source_tier/tier_label
on each edge — do not strip them. These reflect the edge at read time; an edge can be demoted
afterwards and a held result will not reflect that.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hops | No | ||
| limit | No | ||
| entity | No | ||
| offset | No | ||
| search | No | ||
| relation_type | No |