Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

Misc → Metadata

AI-generated

Summary

Modify or delete metadata fields of a PDF document by providing either the file binary input or a server-side file ID, with optional detailed metadata fields to set.

Inputs

  • Input Binary Field Name (File Input) — Specifies the name of the binary property containing the PDF file data when uploading a file directly.
  • File Id — Identifier for a previously uploaded server-side PDF file to modify its metadata without re-uploading.
  • Delete All (required) — If set to true, deletes all existing metadata fields from the PDF document.
  • Author — Sets the author field in the PDF metadata.
  • Creation Date — Sets the creation date of the PDF document (format: yyyy/MM/dd HH:mm:ss).
  • Creator — Sets the creator field in the PDF metadata.
  • Keywords — Sets keywords associated with the PDF document.
  • Modification Date — Sets the modification date of the PDF document (format: yyyy/MM/dd HH:mm:ss).
  • Producer — Sets the producer field in the PDF metadata.
  • Subject — Sets the subject field in the PDF metadata.
  • Title — Sets the title of the PDF document.
  • Trapped — Sets the trapped status of the PDF document with options True, False, or Unknown.
  • All Request Params — Provides a map of custom key-value pairs for additional metadata parameters (keys must start with customKey and customValue for non-standard parameters).

Output shape

a single JSON object containing the updated metadata status and possibly the modified PDF file binary if applicable

Inputs can include either a binary file input or a file ID but the file ID is used for server-side referencing when the file was previously processed asynchronously. The operation supports deleting all metadata or selectively updating specific metadata fields. No pagination or multiple items are returned.

Links

Discussion