Skip to content
LydieDevelopers
Menu

Search documents

View as Markdown
GET/v1/workspaces/{workspaceId}/search

Full-text search over titles and bodies. Words are matched as prefixes; all words must match.

docs:readRead-only
Request
curl "https://api.lydie.co/v1/workspaces/01JCQ3TZ0WJ8K4M2X7T9R6N1PA/search?query=roadmap" \
  -H "Authorization: Bearer $LYDIE_TOKEN"

Path parameters

Query parameters

  • querystringrequired· 1–500 chars
  • limitinteger· 1–50

    Default 20

Response

  • hitsSearchHit[]
    Show 4 fields
    • idULID
    • titlestring
    • snippetstring

      Matching excerpt; matches are wrapped in <mark></mark>.

    • scorenumber

      Lower is better (bm25).

200
{
  "hits": [
    {
      "id": "01JCQ3V5MZ8G4ZK2X7T9R6N1PB",
      "title": "Meeting notes",
      "snippet": "string",
      "score": 0
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.