Skip to main content

Pages

Search pages

Full-text search across all pages in a project — the same engine that powers on-site search. Returns the top results ranked by relevance.

POST/projects/{id}/pages/search
Search pages
curl --request POST \
  --url 'https://api.nookdocs.com/v1/projects/{id}/pages/search' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "query": "<string>"
}'
{
  "results": [
    {
      "path": "<string>",
      "title": "<string>",
      "snippet": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

API key issued from your dashboard (Settings → API Keys). Format: nook_... — pass as Authorization: Bearer nook_.... Keys carry scopes (projects:read/write, pages:read, deployments:read/trigger, analytics:read) — calls without the required scope return 403.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstring (uuid)pathrequired

Request bodyapplication/json

limitintegerbody
querystringbodyrequired
Search query — Google-style syntax (websearch_to_tsquery full-text search).

Response

application/json

Search results ordered by rank

resultsobject[]