- Sync
- Async
Parameters
query(str): Search query for document names/filenameslimit(int, optional): Maximum number of documents to return. Defaults to 10.filters(Dict[str, Any], optional): Optional metadata filtersfolder_name(str | List[str], optional): Optional folder scope (canonical path or list of paths/names)folder_depth(int, optional): Folder scope depth.None/0= exact match,-1= include all descendants,n > 0= include descendants up tonlevels deep.end_user_id(str, optional): Optional end-user scope
Returns
List[Document]: List of matching documents
Metadata Filters
Filters follow the same JSON syntax across the API. See the Metadata Filtering guide for supported operators and typed comparisons. Example:Examples
- Sync
- Async
Notes
- This method searches document names and filenames, not document content. For content-based search, use
retrieve_chunksorretrieve_docs. - The
folder_nameparameter accepts a canonical path (leading slash optional) or a list of paths/names; combine withfolder_depthto include descendants. - Results are returned sorted by relevance to the search query.

