SearchHit

One result.

Type object

Shape

Field	Type	Description
workspacerequired	string
workspace_namerequired	string
document	string or null	Absent when the hit is the workspace itself.
node	string or null
document_kind	string	Kind of the containing manifest entry. Unlike `kind`, this remains `file` when the matching fragment is its mirrored title. Default `""`
mime	string or null	MIME type of an opaque file, when the manifest recorded one. Default `null`
kindrequired	string
fieldrequired	string	A [`field`] token.
titlerequired	string	The document's name, from the listing.
breadcrumbrequired	string	Workspace and the document's title path, assembled at query time - never stored, so renaming a document is one row and re-indexes nothing.
breadcrumb_spansrequired	array of MatchSpan	Offsets in [`Self::breadcrumb`] explaining path matches.
snippetrequired	string
spansrequired	array of MatchSpan
lifecyclerequired	Lifecycle	Whether a hit's document is in the trash. Not a property of a fragment. Trash is a flag on the manifest entry ([ADR-95](../../../docs/decisions/ADR-076-100.md#adr-95-trash--a-document-in-the-trash-is-a-flag-on-its-manifest-entry)), so it is a property of the document, resolved by joining the mirrored listing. Storing it on every fragment is what used to let a hit and its own document title disagree about whether they were binned.
trashed_at	integer (int64) or null
trashed_by	string or null
scorerequired	number (double)
observed_modified_at_ms	integer (int64) or null	When this store last observed different searchable content for the containing document. Derived local metadata, not an authored timestamp, and deliberately not when we last looked.
workspace_last_used_at_ms	integer (int64) or null	Most recent navigation into this workspace on this machine.

Example

{
  "workspace": "string",
  "workspace_name": "string",
  "document": "string",
  "node": "string",
  "document_kind": "",
  "mime": "string",
  "kind": "string",
  "field": "string",
  "title": "string",
  "breadcrumb": "string",
  "breadcrumb_spans": [
    {
      "start": 0,
      "end": 0
    }
  ],
  "snippet": "string",
  "spans": [
    {
      "start": 0,
      "end": 0
    }
  ],
  "lifecycle": "live",
  "trashed_at": 0,
  "trashed_by": "string",
  "score": 0,
  "observed_modified_at_ms": 0,
  "workspace_last_used_at_ms": 0
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated November 12, 2026.