get_folder

Retrieve a folder by name, canonical path, or UUID

Sync

def get_folder(
    folder_id_or_name: str,
) -> Folder

Async

async def get_folder(
    folder_id_or_name: str,
) -> Folder

Parameters

• folder_id_or_name (str): Folder identifier. Accepts the folder’s UUID, name, or canonical path (e.g., /projects/alpha/specs; leading slash optional).

Returns

• Folder: Folder object that can be used to scope operations (ingest, query, etc.).

Folder objects include hierarchy metadata such as full_path, parent_id, depth, and child_count, mirroring the server response.

Examples

Sync

from morphik import Morphik

db = Morphik()
folder = db.get_folder("marketing_docs")
same_folder = db.get_folder(folder.id)
assert folder.id == same_folder.id

Async

from morphik import AsyncMorphik

async with AsyncMorphik() as db:
    folder = await db.get_folder("marketing_docs")
    same_folder = await db.get_folder(folder.id)
    assert folder.id == same_folder.id