Skip to main content
POST
/
api
/
v1
/
read-pdf-metadata
Read PDF metadata
curl --request POST \
  --url https://app.dumplingai.com/api/v1/read-pdf-metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputMethod": "url",
  "files": [
    "https://example.com/report.pdf"
  ]
}'
{}

​
Description

This endpoint reads metadata from PDF files.

​
Endpoint

POST /api/v1/read-pdf-metadata

​
Headers

  • Content-Type: application/json
  • Authorization: Bearer <API_KEY> (required)

​
Request Body

{
  "inputMethod": "string", // Required. Either "url" or "base64"
  "files": ["string"], // Required. Array of URLs or base64-encoded PDF contents
  "requestSource": "string" // Optional. Source of the request
}

​
Responses

​
Success (200)

Returns the metadata from the PDF files. 
{
  "metadata": {
    "Title": "string",
    "Author": "string",
    "Subject": "string",
    "Keywords": "string",
    "Creator": "string",
    "Producer": "string",
    "CreationDate": "string",
    "ModDate": "string"
  }
}

​
Notes

  • This endpoint uses 1 credit per request.
  • Multiple files can be processed in a single request
  • Returns standard PDF metadata fields if available

​
Rate Limiting

Rate limit headers are included in the response.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
inputMethod
enum<string>
required

Indicates whether binary content is supplied via URL or base64-encoded string.

Available options:
url,
base64
​
files
string[]
required

Array of PDF URLs or base64-encoded PDF contents whose metadata should be read.

Minimum length: 1
​
requestSource
enum<string>

Optional identifier describing where the API request originated.

Available options:
API,
WEB,
MAKE_DOT_COM,
ZAPIER,
N8N,
PLAYGROUND,
DEFAULT_AUTOMATION,
AGENT_PREVIEW,
AGENT_LIVE,
AUTOPILOT,
STUDIO

Response

PDF metadata returned.

Metadata extracted for each supplied PDF file.