Get PDF Metadata

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves document properties and metadata from a PDF, and makes the extracted data available for download as JSON.

Endpoint

OAuth Scope

ZohoWriter.pdfEditor.ALLCopied!

Request Example

cURL
cURL
Java
Python
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/pdfeditor/api/v1/pdf/metadata/get \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'file=@file_path' \
  -F 'input_options={
  "properties": [
    "page_count",
    "title",
    "is_encrypted"
  ]
}' \
  -F 'password=OpenSesame123'

Request Body

multipart/form-data
filebinary(Required)

The source PDF to read metadata 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.

Example
quarterly-review.pdf
input_optionsJSON Object(Optional)

Configures which PDF properties are retrieved.

Example
{
  "properties": [
    "page_count",
    "title",
    "is_encrypted"
  ]
}
Show Sub-Attributes
propertiesarray[string](Optional)

The specific properties to retrieve, up to 20. If omitted, every property is returned. Supported values: page_count, title, author, subject, keywords, creator, producer, creation_date, modification_date, trapped, is_encrypted, pdf_version, file_size, linearized, tagged, form_type, permissions, pages, attachment_count, attachment_names.

Example
[
  "page_count",
  "title",
  "is_encrypted"
]
Allowed Values :
Show Values ▾
page_countCopied!
titleCopied!
authorCopied!
subjectCopied!
keywordsCopied!
creatorCopied!
producerCopied!
creation_dateCopied!
modification_dateCopied!
trappedCopied!
is_encryptedCopied!
pdf_versionCopied!
file_sizeCopied!
linearizedCopied!
taggedCopied!
form_typeCopied!
permissionsCopied!
pagesCopied!
attachment_countCopied!
attachment_namesCopied!
Copied!Copy all as JSON Array
Range :[0 .. 20][0 .. 20]
passwordstring(Optional)

The password to unlock the source PDF, if it is password-protected.

Example
OpenSesame123
Maximum Length :255255Copied!

Body Parameters

Copied!
// Note: payload contains multiple type attributes

// type: file
file = quarterly-review.pdf

// type: object
input_options = {
  "properties": [
    "page_count",
    "title",
    "is_encrypted"
  ]
}

// type: string
password = OpenSesame123
▼ Show full

Response Example

200
Copied!
  {
    "status": "inprogress",
    "status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/metadata/get/job/3f65c7592a741d98e46bf310cbe678f574a1d51fce306a8d9b6430217e538acd"
  }
                
▼ Show full

Rate Limits

Duration1 minute
Threshold50
Lock Period5 minutes 30 seconds
Duration1 hour
Threshold200
Lock Period15 minutes
Duration1 day
Threshold2000
Lock Period2 hours

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.