get_graph_status

Get the current status of a graph with pipeline stage information

Sync

def get_graph_status(
    graph_name: str,
    folder_name: Optional[Union[str, List[str]]] = None,
    folder_depth: Optional[int] = None,
    end_user_id: Optional[str] = None,
) -> Dict[str, Any]

Async

async def get_graph_status(
    graph_name: str,
    folder_name: Optional[Union[str, List[str]]] = None,
    folder_depth: Optional[int] = None,
    end_user_id: Optional[str] = None,
) -> Dict[str, Any]

Parameters

• graph_name (str): Name of the graph to check
• folder_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 to n levels deep.
• end_user_id (str, optional): Optional end user ID for scoping

Returns

• Dict[str, Any]: Status information containing status, pipeline_stage (if processing), and other metadata

Examples

Sync

from morphik import Morphik

db = Morphik()

# Check graph status
status = db.get_graph_status("my_knowledge_graph")

print(f"Status: {status.get('status')}")
if status.get('pipeline_stage'):
    print(f"Pipeline stage: {status.get('pipeline_stage')}")

# Check with folder scoping
status = db.get_graph_status(
    graph_name="team_graph",
    folder_name="/engineering/graphs",
    folder_depth=-1,
)
print(f"Graph status in folder: {status.get('status')}")

Async

from morphik import AsyncMorphik

async with AsyncMorphik() as db:
    # Check graph status
    status = await db.get_graph_status("my_knowledge_graph")

    print(f"Status: {status.get('status')}")
    if status.get('pipeline_stage'):
        print(f"Pipeline stage: {status.get('pipeline_stage')}")

    # Check with folder scoping
    status = await db.get_graph_status(
        graph_name="team_graph",
        folder_name="/engineering/graphs",
        folder_depth=-1,
    )
    print(f"Graph status in folder: {status.get('status')}")

Notes

• This is a lightweight endpoint that examines local status metadata and augments it with remote pipeline details when available.
• Use this to monitor graph creation or update progress.
• For polling until completion, consider using wait_for_graph_completion instead.