def list_documents(
skip: int = 0,
limit: int = 100,
filters: Optional[Dict[str, Any]] = None
) -> List[Document]
def list_documents(
skip: int = 0,
limit: int = 100,
filters: Optional[Dict[str, Any]] = None
) -> List[Document]
async def list_documents(
skip: int = 0,
limit: int = 100,
filters: Optional[Dict[str, Any]] = None
) -> List[Document]
Parameters
skip (int, optional): Number of documents to skip. Defaults to 0.limit (int, optional): Maximum number of documents to return. Defaults to 100.filters (Dict[str, Any], optional): Optional filters
Returns
List[Document]: List of accessible documents
Examples
from morphik import Morphik
db = Morphik()
# Get first page
docs = db.list_documents(limit=10)
for doc in docs:
print(f"Document ID: {doc.external_id}")
print(f"Filename: {doc.filename}")
print(f"Metadata: {doc.metadata}")
print("---")
# Get next page
next_page = db.list_documents(skip=10, limit=10, filters={"department": "research"})
from morphik import Morphik
db = Morphik()
# Get first page
docs = db.list_documents(limit=10)
for doc in docs:
print(f"Document ID: {doc.external_id}")
print(f"Filename: {doc.filename}")
print(f"Metadata: {doc.metadata}")
print("---")
# Get next page
next_page = db.list_documents(skip=10, limit=10, filters={"department": "research"})
from morphik import AsyncMorphik
async with AsyncMorphik() as db:
# Get first page
docs = await db.list_documents(limit=10)
for doc in docs:
print(f"Document ID: {doc.external_id}")
print(f"Filename: {doc.filename}")
print(f"Metadata: {doc.metadata}")
print("---")
# Get next page
next_page = await db.list_documents(skip=10, limit=10, filters={"department": "research"})
Document Properties
The Document objects returned by this method have the following properties:
external_id (str): Unique document identifiercontent_type (str): Content type of the documentfilename (Optional[str]): Original filename if availablemetadata (Dict[str, Any]): User-defined metadatastorage_info (Dict[str, str]): Storage-related informationsystem_metadata (Dict[str, Any]): System-managed metadataaccess_control (Dict[str, Any]): Access control informationchunk_ids (List[str]): IDs of document chunks
