Skip to main content
This guide provides a quick overview for getting started with the WRITER PDFParser document loader. WRITER’s PDF Parser converts PDF documents into other formats like text or Markdown. This is particularly useful when you need to extract and process text content from PDF files for further analysis or integration into your workflow. In langchain-writer, we provide usage of WRITER’s PDF Parser as a LangChain document parser.

​
Overview

​
Integration details

ClassPackageLocalSerializableJS supportDownloadsVersion
PDFParserlangchain-writer❌❌❌PyPI - DownloadsPyPI - Version

​
Setup

The PDFParser is available in the langchain-writer package: 
pip install --quiet -U langchain-writer

​
Credentials

Sign up for WRITER AI Studio to generate an API key (you can follow this Quickstart). Then, set the WRITER_API_KEY environment variable: 
import getpass
import os

if not os.getenv("WRITER_API_KEY"):
    os.environ["WRITER_API_KEY"] = getpass.getpass("Enter your WRITER API key: ")
It’s also helpful (but not needed) to set up LangSmith for best-in-class observability. If you wish to do so, you can set the LANGSMITH_TRACING and LANGSMITH_API_KEY environment variables: 
os.environ["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_API_KEY"] = getpass.getpass()

​
Instantiation

Next, instantiate an instance of the WRITER PDF Parser with the desired output format: 
from langchain_writer.pdf_parser import PDFParser

parser = PDFParser(format="markdown")

​
Usage

There are two ways to use the PDF Parser, either synchronously or asynchronously. In either case, the PDF Parser will return a list of Document objects, each containing the parsed content of a page from the PDF file.

​
Synchronous usage

To invoke the PDF Parser synchronously, pass a Blob object to the parse method referencing the PDF file you want to parse: 
from langchain_core.documents.base import Blob

file = Blob.from_path("../example_data/layout-parser-paper.pdf")

parsed_pages = parser.parse(blob=file)
parsed_pages

​
Asynchronous usage

To invoke the PDF Parser asynchronously, pass a Blob object to the aparse method referencing the PDF file you want to parse: 
parsed_pages_async = await parser.aparse(blob=file)
parsed_pages_async

​
API reference

For detailed documentation of all PDFParser features and configurations, head to the API reference.

​
Additional resources

You can find information about WRITER’s models (including costs, context windows, and supported input types) and tools in the WRITER docs.
Edit the source of this page on GitHub.
Connect these docs programmatically to Claude, VSCode, and more via MCP for real-time answers.
⌘I