SearchPage

Type object

Shape

Field	Type	Description
hitsrequired	array of SearchHit
next_offset	integer (uint, >= 0) or null
updating_workspacesrequired	array of string	Workspaces the answer may be behind on - not yet compared against the store since it came up, or with indexing still queued. Reported rather than waited on: a query that blocked until every workspace was current would be correct and occasionally unbounded.
request_seqrequired	integer (uint64, >= 0)
corrected_query	string or null	A corrected spelling inferred from the highest-ranked result. Absent when the authored query itself supplied the evidence.

Example

{
  "hits": [
    {
      "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
    }
  ],
  "next_offset": 0,
  "updating_workspaces": [
    "string"
  ],
  "request_seq": 0,
  "corrected_query": "string"
}

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.