Browse documentation
Follow the thread
Coverage Graph: the connected neighbourhood of a passage — 'follow the thread'.
get
/related Request
curl \
-H "x-api-key: $UNLOB_API_KEY" \
"https://api.unlob.com/related?id=<id>"Behaviour
A bounded k-hop walk over hosted-on / same-story / topic / entity edges, returning the passages it reaches. The edges are what to read next, so one call decomposes a question that would otherwise be a search per hop.
Raise hops to widen the net; 2 is usually right, and 3 gets noisy fast.
Parameters
| Name | Type | Description |
|---|---|---|
idrequired | string | Start passage id. |
hops | integer | Walk depth, default 2. |
limit | integer | Maximum hits, default 10. |
Responses
| Status | Meaning |
|---|---|
200 | The connected neighbourhood. |
401 | Missing, unknown or revoked key. A key minted moments ago can answer 401 until it propagates to the serving fleet. |
429 | Over the per-minute rate, or past a hard-capped monthly quota. `retry-after` is present on the rate-limit case only. |
Response body
WebSearchResponse
| Name | Type | Description |
|---|---|---|
facets | object | Present only when facets=true |
moderequired | "keyword" | "semantic" | "hybrid" | The mode actually used |
partial | boolean | true when at least one shard failed or timed out — the answer is short because a slice of the corpus was unreachable, NOT because that is all there is. Never treat a partial result as complete. |
resultsrequired | object[] | — |
routedrequired | boolean | true when the router chose the vertical, false when you named it |
totalrequired | integer | — |
vertical | string | null | The vertical actually queried |
The same call over MCP is a tool with these parameter names unchanged. See Errors for what to do with each status.