Fonts

Get font substitutions

This endpoint allows you to get font substitutions that were set for the specific document.

Note that font substitutions returned by this endpoint will include the font substitutions defined for the specified document, as well as any font substitutions defined in the font-substitutions.json configuration file, if a font-substitutions.json file is mounted on Document Engine.

The font substitutions for the document will be merged with the font substitutions in font-substitutions.json if any, with the substitutions in the document having priority over any substitutions font-substitutions.json may define. It is this combination of font substitutions that will be applied by Document Engine when performing operations on the document where a font is unavailable and needs to be substituted.

Learn more about the font-substitutions.json file from the documentation available here: https://www.nutrient.io/guides/document-engine/configuration/custom-fonts/#font-substitutions

get/api/documents/{documentId}/font_substitutions

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/font_substitutions
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Response

List of font substitutions used in the document.

Example response

{
  "data": [
    {
      "pattern": "Roboto-*",
      "target": "Courier New"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.