v1

latestOpenAPI 3.1.02026-07-17325265.6 KB
Files

Fuzzy search for files and folders

Performs fuzzy matching on file and folder paths within specified directories. Returns matches sorted by relevance with character-level highlighting information.

Respects .gitignore by default. Search completes within 5 seconds or returns partial results with timeout error.

post/fuzzy-search/files

Request body

querystring required

Fuzzy search pattern

pathsstring[] required

Directory paths to search within

limitinteger

Maximum number of results to return

filesOnlyboolean

Return only files, exclude directories

respectGitignoreboolean

Filter out files/folders matching .gitignore patterns

Example request

{
  "query": "handleFuzzy",
  "paths": [
    "/Users/dev/project"
  ]
}

Response

Search completed successfully

Example response

{
  "results": [
    {
      "path": "/Users/dev/project/src/handlers/fuzzySearch.go",
      "displayPath": "src/handlers/fuzzySearch.go",
      "score": 85,
      "matchedIndexes": [
        23,
        31,
        36,
        37,
        38,
        39
      ]
    }
  ],
  "metadata": {
    "totalScanned": 15437,
    "totalMatches": 42,
    "durationMs": 156
  }
}
All 32 operations