hops
DEPRECATED alias for relationships — kept working, to be removed at a future major. Use
relationships. Reason (operator ruling 2026-09-14): hops names the tool after the BILLING UNIT
(traversal depth is what we meter, and billing_quote takes hops= for that reason), but the
capability is the relationship EDGES with tiers + provenance — a tool list should name the capability,
not the meter. Identical behavior and params to relationships (incl. an unknown relation_type = 400 on
both paths, before any charge; entity_type + entity_id pin one entity, and a name matching several is a 409 listing
the candidates, nothing charged); also the SDK helper name.
⚠ CHARGING: the meter RESERVES before the query runs and SETTLES after delivery for what was actually
delivered (an empty result settles to 0; a partial traversal settles for the hops delivered; a 4xx
releases the reservation). An abandoned or timed-out call still settles once the backend delivers.
A replay is served free only for the SAME credential + SAME idempotency key + SAME request within
15 minutes — a different payer is a different payer. Every call through this relay carries a fresh
key, so a retry here is always a new charge. Price with billing_quote first; verify any charge
with the billing_attempts tool (own wallet: reserved vs settled, per attempt).
WHAT YOU PAID: the JSON response carries a top-level charged_joules — the all-in PRICE of this call —
and a metering block written AFTER the settle has run: {attempt_id, settlement, settled_joules, check}.
metering.settlement is whether you PAID: settled · settled_zero (empty result, nothing moved) ·
settle_failed (delivered but UNPAID — the wallet is then locked until it clears; the next metered call
402s naming the attempt, the amount and what clears it) · released (4xx/5xx, nothing moved) · unknown.
settled_joules is what actually left the wallet (0 unless settled). A cached replay carries no block.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hops | No | ||
| as_of | No | ||
| limit | No | ||
| entity | No | ||
| offset | No | ||
| search | No | ||
| entity_id | No | ||
| entity_type | No | ||
| relation_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||