> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dumplingai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read PDF Metadata

> Read metadata fields embedded in a PDF document.

## 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

```json theme={null}
{
  "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.

```json theme={null}
{
  "metadata": {
    "Title": "string",
    "Author": "string",
    "Subject": "string",
    "Keywords": "string",
    "Creator": "string",
    "Producer": "string",
    "CreationDate": "string",
    "ModDate": "string"
  }
}
```

## Notes

* This endpoint uses 10 credits 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.


## OpenAPI

````yaml POST /api/v1/read-pdf-metadata
openapi: 3.0.3
info:
  title: DumplingAI API
  version: 1.0.0
  description: >
    REST API for DumplingAI's content intelligence and automation platform.

    All endpoints are grouped under `/api/v1`; most are secured via Bearer API
    keys unless an operation explicitly sets `security: []`.
servers:
  - url: https://app.dumplingai.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: YouTube
    description: Access metadata, search results, and transcripts from YouTube.
  - name: TikTok
    description: Retrieve TikTok profile, video, follower, and transcript data.
  - name: LinkedIn
    description: Programmatically fetch LinkedIn company and profile data.
  - name: Search
    description: Search-orientated endpoints spanning web, news, maps, and autocomplete.
  - name: Google
    description: Integrations with Google business listings and location data.
  - name: Scraping
    description: Webpage capture, crawling, and structured content extraction utilities.
  - name: Documents
    description: Document processing, conversion, and metadata utilities.
  - name: AI
    description: DumplingAI agent and knowledge base endpoints.
  - name: Developer Tools
    description: Utilities for executing sandboxed code via API.
paths:
  /api/v1/read-pdf-metadata:
    post:
      tags:
        - Documents
      summary: Read PDF metadata
      description: Read metadata fields embedded in a PDF document.
      operationId: readPdfMetadata
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadPdfMetadataRequest'
            examples:
              default:
                value:
                  inputMethod: url
                  files:
                    - https://example.com/report.pdf
      responses:
        '200':
          description: PDF metadata returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadPdfMetadataResponse'
        '400':
          description: Invalid request payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ReadPdfMetadataRequest:
      type: object
      required:
        - inputMethod
        - files
      properties:
        inputMethod:
          $ref: '#/components/schemas/FileInputMethod'
        files:
          type: array
          minItems: 1
          description: >-
            Array of PDF URLs or base64-encoded PDF contents whose metadata
            should be read.
          items:
            type: string
        requestSource:
          $ref: '#/components/schemas/RequestSource'
      additionalProperties: false
    ReadPdfMetadataResponse:
      type: object
      description: Metadata extracted for each supplied PDF file.
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable description of what went wrong.
      required:
        - error
    FileInputMethod:
      type: string
      description: >-
        Indicates whether binary content is supplied via URL or base64-encoded
        string.
      enum:
        - url
        - base64
    RequestSource:
      type: string
      description: Optional identifier describing where the API request originated.
      enum:
        - API
        - WEB
        - MAKE_DOT_COM
        - ZAPIER
        - N8N
        - PLAYGROUND
        - DEFAULT_AUTOMATION
        - AGENT_PREVIEW
        - AGENT_LIVE
        - AUTOPILOT
        - STUDIO
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````