Templates

List Word bookmarks available for bookmark placement

Renders the DOCX template and reports the named destinations that reached the PDF. A bookmark is invisible in the document and in the rendered output, so this is how you confirm a name exists and see the form the converter rewrote it to.

get/api/v1/templates/{id}/bookmarks

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates/{id}/bookmarks
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Response

missingstring[] required

Bookmark names declared in the DOCX that reached no destination in the rendered document. A field bound to one of these places nothing, and the bookmark list alone would look healthy, so treat a name of your own appearing here as a template setup failure. The most common cause is a bookmark placed after a Word field code (a REF cross-reference, a PAGE number) in the same paragraph: the converter drops it. Move the bookmark before the field. Empty for PDF templates, which have no DOCX to compare against.

Example response

{
  "bookmarks": [
    {
      "name": "SigSeller",
      "pageNumber": 1
    }
  ],
  "ambiguous": [
    {
      "key": "Sig5FSeller",
      "names": [
        "Sig_Seller",
        "Sig5FSeller"
      ]
    }
  ],
  "missing": [
    "_Ref418700706"
  ]
}

Changes

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