search

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query"
    },
    "type": {
      "description": "Which sections to return. Omit to return all four. Use to skip expensive paths — e.g. ['catalog'] for registry-only lookups, ['releases'] for pure release search, ['collections'] for a quick playlist lookup.",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "orgs",
          "catalog",
          "releases",
          "collections"
        ]
      }
    },
    "organization": {
      "description": "Scope release results to sources belonging to this organization. Accepts an org_ id, slug, or registered domain.",
      "type": "string"
    },
    "domain": {
      "description": "Scope to the org owning this domain. Input is normalized (scheme/path/www stripped, lowercased), so `https://vercel.com/` and `vercel.com` both work. Falls back to a 'no match' message when the domain isn't owned by anything indexed. Use this instead of `organization` when you have a URL-shaped input.",
      "type": "string"
    },
    "entity": {
      "description": "Scope release results to one catalog entry. Accepts a prod_ id (expands to every source under the product), a src_ id, or an org-scoped coordinate in the form orgSlug/slug (e.g. 'vercel/nextjs'). Bare slugs without an org prefix are not accepted.",
      "type": "string"
    },
    "product": {
      "description": "Scope release results to a specific product's sources. Accepts a prod_ id or an org-scoped coordinate in the form orgSlug/productSlug (e.g. 'vercel/next-js'). Bare slugs without an org prefix are not accepted. When both `entity` and `product` are supplied, `entity` takes precedence. The resolved product coordinate is echoed on `_meta.search.product`.",
      "type": "string"
    },
    "limit": {
      "description": "Max results per section (default 20)",
      "type": "number"
    },
    "mode": {
      "description": "Release-retrieval strategy. 'hybrid' (default) fuses FTS + vector results. 'lexical' is legacy FTS only. 'semantic' is vectors only. Falls back to lexical if vector infra is unavailable.",
      "type": "string",
      "enum": [
        "lexical",
        "semantic",
        "hybrid"
      ]
    },
    "include_coverage": {
      "description": "Include releases grouped as coverage of another (e.g. marketing posts that re-announce a platform release). Defaults to false so each underlying launch appears once.",
      "type": "boolean"
    },
    "include_empty": {
      "description": "Include orgs with zero indexed releases in the `orgs` section. Default false — empty orgs are stubs and surface as noise. Scoping by `domain` ignores this and always returns the resolved org.",
      "type": "boolean"
    },
    "kind": {
      "description": "Filter to a specific source/product kind. Release hits resolve through `source.kind ?? product.kind`; catalog hits filter on the row's own kind. The orgs and collections sections are unaffected; changelog chunk hits are unaffected.",
      "type": "string",
      "enum": [
        "platform",
        "sdk",
        "mobile",
        "desktop",
        "docs",
        "integration",
        "tool"
      ]
    },
    "since": {
      "description": "Keep only release hits published at or after this bound. Accepts an ISO date/datetime (`2026-01-01`) or relative shorthand (`90d`, `4w`, `6m`, `2y`). Filters `published_at`; undated releases are dropped. Only the releases section is affected — great for capability-discovery queries like 'who added X in the last 90 days'.",
      "type": "string"
    },
    "until": {
      "description": "Keep only release hits published at or before this bound. Same input formats as `since`.",
      "type": "string"
    }
  },
  "required": [
    "query"
  ]
}