Morphik

Main client for document operations in Morphik

Usage

Sync

from morphik import Morphik

# Without authentication
db = Morphik()

# With authentication
db = Morphik("morphik://owner_id:[e-mail]")

Async

from morphik import AsyncMorphik

# Without authentication
async with AsyncMorphik() as db:
    doc = await db.ingest_text("Sample content")

# With authentication
async with AsyncMorphik("morphik://owner_id:[e-mail]") as db:
    doc = await db.ingest_text("Sample content")

User and Folder Scoping

Morphik supports organizing and isolating data by user and folder. This provides a way to build multi-tenant applications and organize documents across projects.

Quick Overview

Sync

# Folder scoping - organize by project or category
folder = db.create_folder("project_x")
doc = folder.ingest_text("This document belongs to Project X")

# User scoping - isolate data by end user
user_scope = db.signin("user123")
doc = user_scope.ingest_text("This belongs to user123 only")

# Combined scoping - organize by both user and folder
user_folder_scope = folder.signin("user123")
doc = user_folder_scope.ingest_text("This belongs to user123 in project_x")

Async

# Folder scoping - organize by project or category
folder = db.create_folder("project_x")
doc = await folder.ingest_text("This document belongs to Project X")

# User scoping - isolate data by end user
user_scope = db.signin("user123")
doc = await user_scope.ingest_text("This belongs to user123 only")

# Combined scoping - organize by both user and folder
user_folder_scope = folder.signin("user123")
doc = await user_folder_scope.ingest_text("This belongs to user123 in project_x")

Nested folders are supported across the SDK. Use canonical paths (e.g., "/projects/alpha/specs") when creating or scoping folders, and pass folder_depth on retrieval/list helpers to include descendant folders.

For detailed documentation and examples:

• Folder Management - Organizing documents by logical groups
• User Management - Multi-tenant isolation and user-level data management

Constructor

Both clients share the same constructor parameters:

Sync

Morphik(
    uri: Optional[str] = None,
    timeout: int = 30,
    is_local: bool = False,
    http2: Optional[bool] = None,
    http2_fallback: bool = True,
)

Async

AsyncMorphik(
    uri: Optional[str] = None,
    timeout: int = 30,
    is_local: bool = False,
    http2: Optional[bool] = None,
    http2_fallback: bool = True,
)

Parameters

• uri (str, optional): Morphik URI in format “morphik://<owner_id>:<token>@<host>”. If not provided, connects to http://localhost:8000 without authentication.
• timeout (int, optional): Request timeout in seconds. Defaults to 30.
• is_local (bool, optional): Whether connecting to local development server. Defaults to False.
• http2 (bool, optional): Enable HTTP/2 when possible. Defaults to None (auto-disabled for local).
• http2_fallback (bool, optional): Fall back to HTTP/1.1 if HTTP/2 fails. Defaults to True.

Methods

Morphik provides the following methods. Each method page includes both synchronous and asynchronous versions.

Document Ingestion

• ingest_text
• ingest_file
• ingest_files
• ingest_directory
• query_document

Document Retrieval

• retrieve_chunks
• retrieve_chunks_grouped
• retrieve_docs
• query
• list_documents
• search_documents
• get_document
• get_document_by_filename

Document Updates & Summaries

• update_document_with_text
• update_document_with_file
• update_document_metadata
• update_document_by_filename_with_text
• update_document_by_filename_with_file
• update_document_by_filename_metadata
• get_document_summary
• upsert_document_summary
• get_document_status
• wait_for_document_completion

Document Management

• get_document_file
• extract_document_pages
• get_document_download_url
• delete_document
• delete_document_by_filename
• batch_get_documents
• batch_get_chunks

Folder & User Scoping

• folders
• create_folder
• list_folders
• get_folder
• get_folder_by_name
• get_folder_summary
• upsert_folder_summary
• get_folders_summary
• get_folders_details
• add_document_to_folder
• remove_document_from_folder
• delete_folder
• users

Apps & Ops

• list_apps
• create_app
• generate_cloud_uri
• rename_app
• rotate_app_token
• delete_app
• requeue_ingestion_jobs
• get_logs
• get_health
• get_app_storage_usage
• ping

Chat & Conversation

• list_chat_conversations
• get_chat_history

Client Management

• close

Context Manager

Using the Morphik client as a context manager ensures that resources are properly closed when the context exits.

Sync

with Morphik() as db:
    doc = db.ingest_text("Sample content")

Async

async with AsyncMorphik() as db:
    doc = await db.ingest_text("Sample content")