Releases Index
Related releases
View .md

Releases semantically similar to an anchor release

GET
/related/releases

Pulls the anchor's vector from the RELEASES_INDEX Vectorize index via getByIds, then runs a follow-up query with that vector. The anchor itself is always excluded from results. scope=org filters by the anchor's org id (Vectorize metadata filter on org_id); scope=global (default) is unscoped.

Degrades gracefully: when the binding is missing, the anchor isn't embedded yet, or Vectorize errors, the response is { degraded: true, degradedReason, items: [] } with HTTP 200 — callers render nothing in that case. degradedReason is human-readable and not stable.

Ranking: topK is over-fetched (min(max(limit * 10, 50), 100)), then candidates are ranked server-side by cosine × recency × contentWeight and sliced to limit. Content-free releases (empty bodies, boilerplate "no changes" notes) are dropped entirely; short-but-real releases are down-weighted; recency uses a 45-day half-life. Items are returned already in display order.

Authorization

bearerAuth
headerAuthorizationBearer <relk_… | relu_… | OAuth JWT>

Machine/operator tokens use the relk_ prefix; self-serve read-only user keys use relu_; Sign in with Releases supplies an OAuth access token. Required scope depends on the endpoint.

Query Parameters

release*string

Anchor release id (rel_…).

scope?string

Restrict candidates to the anchor's org, or run unscoped.

Default"global"
Value in"org""global"
limit?integer

Max neighbors to return. Clamped to 1–25.

Range1 <= value <= 25
Default8
excludeOrg?string

Org slug to drop from results before slicing. Used by the global rail to avoid overlap with an org-scoped rail rendered alongside it.

Response Body

Successful or degraded neighbor list.

application/json
  1. response
scope*string
Value in"org""global"
items*array<>
Example Request
curl -X GET 'https://api.releases.sh/v1/related/releases?release=string'
Example Response
{  "scope": "org",  "items": [    {      "id": "string",      "title": "string",      "version": "string",      "url": "string",      "publishedAt": "string",      "summary": "string",      "titleGenerated": "string",      "titleShort": "string",      "importance": 1,      "thumbnail": {        "url": "string",        "alt": "string"      },      "score": 0,      "source": {        "id": "string",        "slug": "string",        "name": "string",        "productName": "string",        "orgSlug": "string",        "orgName": "string",        "orgAvatarUrl": "string",        "appStore": {          "platform": "ios",          "iconUrl": "string"        }      }    }  ]}