Extract PDF Content
Extracts selected content from a PDF — text, images, attachments, metadata, and more — into a downloadable ZIP archive.
Endpoint
OAuth Scope
curl --request POST \
--url https://www.zohoapis.com/pdfeditor/api/v1/pdf/content/extract \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: multipart/form-data' \
-F 'file=@file_path' \
-F 'input_options={
"extract_text": true,
"extract_images": true,
"extract_attachments": false,
"extract_metadata": false,
"extract_annotations": false,
"extract_bookmarks": false,
"extract_rich_media": false,
"extract_stamps": false,
"extract_xmp_metadata": false,
"extract_vector_graphics": false
}' \
-F 'password=OpenSesame123'Request Body
multipart/form-dataThe source PDF to extract content from, uploaded directly or imported from a publicly accessible URL. The file must be no larger than 50 MB, contain no more than 400 pages, and have no page larger than 2,400 square inches. Its filename must not exceed 255 characters. Supported formats: pdf.
Configures which content types are extracted from the PDF. At least one setting must be provided.
{
"extract_text": true,
"extract_images": true,
"extract_attachments": false,
"extract_metadata": false,
"extract_annotations": false,
"extract_bookmarks": false,
"extract_rich_media": false,
"extract_stamps": false,
"extract_xmp_metadata": false,
"extract_vector_graphics": false
}Show Sub-Attributes
Extracts the PDF's text content to extracted_text.txt in the output ZIP.
Extracts each embedded image as its own file in the output ZIP.
Extracts embedded file attachments, both document-level and page-annotation-level, into an attachments/ folder in the output ZIP.
Extracts the document's standard metadata (title, author, subject, keywords, creator, producer, creation and modification dates, page count, and encryption status) to metadata.json.
Extracts link URLs and comment text from the PDF's annotations into the extraction report.
Extracts the PDF's bookmark/outline tree to bookmarks.json.
Extracts rich media (video/3D) annotation details into the extraction report.
Extracts rubber-stamp annotations, including their custom appearance images, into the output ZIP and the extraction report.
Extracts the document's raw XMP metadata to xmp_metadata.xml.
Renders each page as a PNG image using a vector-only renderer, useful for capturing vector graphics that aren't otherwise extracted.
The password to unlock the source PDF, if it is password-protected.
// Note: payload contains multiple type attributes
// type: file
file = quarterly-review.pdf
// type: object
input_options = {
"extract_text": true,
"extract_images": true,
"extract_attachments": false,
"extract_metadata": false,
"extract_annotations": false,
"extract_bookmarks": false,
"extract_rich_media": false,
"extract_stamps": false,
"extract_xmp_metadata": false,
"extract_vector_graphics": false
}
// type: string
password = OpenSesame123 {
"status": "inprogress",
"status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/content/extract/job/3f65c7592a741d98e46bf310cbe678f574a1d51fce306a8d9b6430217e538acd"
}
Rate Limits
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.