Functions — github.com/PSPDFKit/nutrient-document-engine-mcp-server

hub / github.com/PSPDFKit/nutrient-document-engine-mcp-server / functions

Functions448 in github.com/PSPDFKit/nutrient-document-engine-mcp-server

⨍ Functions 448◇ Types & classes 238

* Uploads multiple documents to the Document Engine * @param {Array<string>} filePaths - Array of file paths to upload * @param {Object} options - U

examples/langgraphjs/shared/fileHandlers.js:91

↓ 1 callersFunctionuploadHandler

(client: DocumentEngineClient, req: Request, res: Response)

src/dashboard/routes.ts:69

↓ 1 callersFunctionuploadResultsTemplate

( results: { filename: string; success: boolean; error?: string }[] )

src/dashboard/templates/uploadResults.ts:1

↓ 1 callersMethoduploadTestDocuments

* Upload test documents to Document Engine with specific IDs and create all required layers * This ensures all layer evaluation scenarios have the

evaluation/runner.ts:125

↓ 1 callersFunctionuseCopyToClipboard

({ copiedDuration = 3000, }: { copiedDuration?: number; } = {})

examples/document-chat/apps/web/src/components/thread/markdown-text.tsx:23

↓ 1 callersFunctionuseInterruptedActions

({ interrupt, }: UseInterruptedActionsInput)

examples/document-chat/apps/web/src/components/thread/agent-inbox/hooks/use-interrupted-actions.tsx:53

↓ 1 callersFunctionvalidateAndConvertPages

* Validate page indices and convert to 1-based page numbers for the API

src/tools/document-editing/rotatePages.ts:40

↓ 1 callersFunctionvalidateEnvironment

()

src/utils/Environment.ts:46

↓ 1 callersFunctionvalidatePageRange

* Validate page range object

src/tools/document-editing/mergeDocumentPages.ts:50

↓ 1 callersFunctionwaitForDocumentEngine

* Polls the Document Engine API until it's ready * @returns Promise that resolves with the client when ready

src/index.ts:40

↓ 1 callersFunctionwithLogging

* Wraps a tool function with entry/exit logging

src/mcpTools.ts:73

Method'apply-document-layer-redactions'

* apply-document-layer-redactions - Apply Redactions to a Layer * * Use this endpoint to apply existing redaction annotation to the default laye

src/api/DocumentEngineSchema.ts:18697

Method'apply-document-redactions'

* apply-document-redactions - Apply Redactions * * Use this endpoint to apply existing redaction annotation to the default layer, erasing * a

src/api/DocumentEngineSchema.ts:18138

Method'build-document'

* build-document - Process Documents And Download the Result * * This endpoint allows to use [Build instructions](#tag/Build-API) to process a d

src/api/DocumentEngineSchema.ts:17457

Method'bulk-delete-documents'

* bulk-delete-documents - Bulk Delete Documents * * Deletes multiple documents based on the provided filter criteria. This endpoint allows for e

src/api/DocumentEngineSchema.ts:17233

Method'copy-document'

* copy-document - Copy a Document * * You can use this endpoint to copy the document, without having to reupload * it to Document Engine *

src/api/DocumentEngineSchema.ts:19271

Method'copy-document-layer-with-instant-json'

* copy-document-layer-with-instant-json - Copy the Layer Into a New Document, Applying the Instant JSON * * If the content type of the request i

src/api/DocumentEngineSchema.ts:18877

Method'copy-document-with-instant-json'

* copy-document-with-instant-json - Copy a Default Layer With Instant JSON * * This will create a new PDF containing the latest annotations of t

src/api/DocumentEngineSchema.ts:17685

Method'create-document-annotation'

* create-document-annotation - Create Annotations * * This endpoint allows you to add one or more new annotations to a document's default layer.

src/api/DocumentEngineSchema.ts:17817

Method'create-document-annotation-comments'

* create-document-annotation-comments - Add Comments to a Root Annotation * * Use this endpoint to add new comments to an existing annotation in

src/api/DocumentEngineSchema.ts:18066

Method'create-document-bookmark'

* create-document-bookmark - Create a Bookmark * * Bookmarks can be created with and without specifying the ID for the bookmark. When no ID is s

src/api/DocumentEngineSchema.ts:17713

Method'create-document-comments'

* create-document-comments - Adds Comments * * Use this endpoint to add comments and their root annotation at the same time. * * Note that

src/api/DocumentEngineSchema.ts:18084

Method'create-document-form-field'

* create-document-form-field - Create Form Fields * * This endpoint allows you to add a new form field to the document's default layer. *

src/api/DocumentEngineSchema.ts:18194

Method'create-document-form-field-widget'

* create-document-form-field-widget - Create Widgets * * This endpoint allows you to add a new widget to the document's default layer. * *

src/api/DocumentEngineSchema.ts:18264

Method'create-document-layer-annotation'

* create-document-layer-annotation - Create Annotations in a Layer * * This endpoint allows you to add one or more new annotations to a specific

src/api/DocumentEngineSchema.ts:18518

Method'create-document-layer-annotation-comments'

* create-document-layer-annotation-comments - Add Comments to a Root Annotation in a Layer * * Use this endpoint to add new comments to the exis

src/api/DocumentEngineSchema.ts:18624

Method'create-document-layer-bookmark'

* create-document-layer-bookmark - Create a Bookmark in a Layer * * Bookmarks can be created with and without specifying the ID for the bookmark

src/api/DocumentEngineSchema.ts:18989

Method'create-document-layer-comments'

* create-document-layer-comments - Add Comments in a Layer * * Use this endpoint to add comments and their root annotation at the same time.

src/api/DocumentEngineSchema.ts:18642

Method'create-document-layer-form-fields'

* create-document-layer-form-fields - Create Form Fields in a Layer * * This endpoint allows you to add a new form field to a layer of the docum

src/api/DocumentEngineSchema.ts:19072

Method'create-document-layer-redactions'

* create-document-layer-redactions - Create Redactions in a Layer * * Use this endpoint to add multiple redaction annotations in a single reques

src/api/DocumentEngineSchema.ts:18674

Method'create-document-layer-widgets'

* create-document-layer-widgets - Create Widgets in a Layer * * This endpoint allows you to add a new widget to a layer of the document *

src/api/DocumentEngineSchema.ts:19145

Method'create-document-redactions'

* create-document-redactions - Create Redactions * * Use this endpoint to add multiple redaction annotations in a single request. * * Avai

src/api/DocumentEngineSchema.ts:18115

Method'create-new-layer'

* create-new-layer - Create a New Layer * * This endpoint allows you to create a new layer for a document. It supports three modes * of opera

src/api/DocumentEngineSchema.ts:18404

Method'create-secret'

* create-secret - Add a Secret * * Creates a new secret. This does not replace previous secrets of this type.

src/api/DocumentEngineSchema.ts:19313

Method'delete-document'

* delete-document - Delete a Document * * Deletes a document with all of its annotation, underlying PDF file and attachments * not referenced

src/api/DocumentEngineSchema.ts:17286

Method'delete-document-annotation'

* delete-document-annotation - Delete an Annotation * * This endpoint allows you to delete an annotation in the document's default layer.

src/api/DocumentEngineSchema.ts:17897

Method'delete-document-bookmark'

* delete-document-bookmark - Delete a Bookmark

src/api/DocumentEngineSchema.ts:17733

Method'delete-document-layer-annotation'

* delete-document-layer-annotation - Delete an Annotation in a Layer. * * This endpoint allows you to delete an annotation in the given layer.

src/api/DocumentEngineSchema.ts:18596

Method'delete-document-layer-bookmark'

* delete-document-layer-bookmark - Delete a Bookmark in a Layer

src/api/DocumentEngineSchema.ts:19011

Method'delete-font-substitutions'

* delete-font-substitutions - Deletes all font substitutions in the document * * This endpoint allows you to delete all font substitutions in th

src/api/DocumentEngineSchema.ts:18345

Method'delete-font-substitutions-in-layer'

* delete-font-substitutions-in-layer - Deletes all font substitutions in the document layer * * This endpoint allows you to delete all font subs

src/api/DocumentEngineSchema.ts:19239

Method'delete-layer'

* delete-layer - Delete a Layer * * This endpoint allows you to delete a layer along with all of its contents.

src/api/DocumentEngineSchema.ts:18416

Method'document-apply-instant-json'

* document-apply-instant-json - Apply an Instant JSON to Document * * To import an Instant JSON file and apply it to an existing document, you c

src/api/DocumentEngineSchema.ts:17645

Method'document-apply-instructions'

* document-apply-instructions - Process Documents And Persist the Result * * This endpoint allows to use [Build instructions](#tag/Build-API) to

src/api/DocumentEngineSchema.ts:17510

Method'document-layer-apply-instructions'

* document-layer-apply-instructions - Edit the Layer and Persist the Result * * This endpoints allows to use instructions pipeline for document

src/api/DocumentEngineSchema.ts:18962

Method'download-document-layer-pdf'

* download-document-layer-pdf - Download the Layer as a PDF * * This operation downloads the latest version of the document with * annotation

src/api/DocumentEngineSchema.ts:18432

Method'download-document-layer-pdf-post'

* download-document-layer-pdf-post - Download the Layer as a PDF * * This operation downloads the latest version of the document with annotation

src/api/DocumentEngineSchema.ts:18447

Method'download-document-layer-with-instant-json'

* download-document-layer-with-instant-json - Download a PDF, Applying the Instant JSON to a Layer * * To import an Instant JSON file and downlo

src/api/DocumentEngineSchema.ts:18860

Method'download-document-pdf'

* download-document-pdf - Download the Document as a PDF * * This operation downloads the latest version of the document with annotations * a

src/api/DocumentEngineSchema.ts:17587

Method'download-document-pdf-post'

* download-document-pdf-post - Download the Document as a PDF * * This operation downloads the latest version of the document as a PDF file.

src/api/DocumentEngineSchema.ts:17601

Method'download-document-with-instant-json'

* download-document-with-instant-json - Download a Document with Instant JSON * * To import an Instant JSON file and download the resulting PDF,

src/api/DocumentEngineSchema.ts:17665

Method'edit-and-download-document-pdf'

* edit-and-download-document-pdf - Edit the Document and Download it * * > ⚠️ This endpoint is deprecated. Please use `/api/build` instead. *

src/api/DocumentEngineSchema.ts:17562

Method'edit-and-persist-document-pdf'

* edit-and-persist-document-pdf - Edit the Document and Persist the Result * * > ⚠️ This endpoint is deprecated. Please use `/api/documents/{doc

src/api/DocumentEngineSchema.ts:17537

Method'expire-secret'

* expire-secret - Update a Secret * * Updates existing secret. This is usually done to update the expiration date of existing secrets.

src/api/DocumentEngineSchema.ts:19333

Method'fetch-document-annotation-comments'

* fetch-document-annotation-comments - Get Comments For a Root Annotation * * Use this endpoint to list all the annotation attached to the given

src/api/DocumentEngineSchema.ts:18051

Method'fetch-document-info'

* fetch-document-info - Fetch Document Information * * This endpoint allows you to fetch the document's page count, * the dimensions of each

src/api/DocumentEngineSchema.ts:17309

Method'fetch-document-layer-annotation-comments'

* fetch-document-layer-annotation-comments - Get Comments For a Root Annotation in a Layer * * Use this endpoint to list all the comments attach

src/api/DocumentEngineSchema.ts:18609

Method'fetch-document-layer-info'

* fetch-document-layer-info - Fetch Document Layer Information * * This endpoint allows you to fetch the page count, * the dimensions of each

src/api/DocumentEngineSchema.ts:18831

Method'fetch-document-properties'

* fetch-document-properties - Fetch Document Properties * * This endpoint allows you to fetch properties of a document * including its title,

src/api/DocumentEngineSchema.ts:17325

Method'get-async-job-status'

* get-async-job-status - Get the status of an async job * * Get the status of a previously scheduled asynchronous job * * If a job is `can

src/api/DocumentEngineSchema.ts:17253

Method'get-configured-font-substitutions'

* get-configured-font-substitutions - Get the list of font substitutions in the configured `font-substitutions.json` file, if any. * * If a `fon

src/api/DocumentEngineSchema.ts:17275

Method'get-document-annotation'

* get-document-annotation - Get Annotation * * Use this endpoint to get the annotation from the document's default layer.

src/api/DocumentEngineSchema.ts:17869

Method'get-document-annotations'

* get-document-annotations - Get Annotations * * You can use this endpoint to fetch all annotations from the document's default layer. * *

src/api/DocumentEngineSchema.ts:17769

Method'get-document-attachment'

* get-document-attachment - Get Attachment * * Attachments are files that are attached to a document. * * This endpoint provides a way to

src/api/DocumentEngineSchema.ts:18152

Method'get-document-bookmarks'

* get-document-bookmarks - Fetch Bookmarks * * Fetches all bookmarks in a given document.

src/api/DocumentEngineSchema.ts:17698

Method'get-document-digital-signatures'

* get-document-digital-signatures - Get Digital Signatures * * Returns a document's digital signatures. * * A document's digital signature

src/api/DocumentEngineSchema.ts:18038

Method'get-document-embedded-files'

* get-document-embedded-files - Fetch Embedded Files * * Returned records describe files that are attached to a document. * * Use attachme

src/api/DocumentEngineSchema.ts:17747

Method'get-document-form-field'

* get-document-form-field - Get a Form Field * * Use this endpoint to get the form field with the specified ID from the document's default layer

src/api/DocumentEngineSchema.ts:18224

Method'get-document-form-field-values'

* get-document-form-field-values - Get Form Field Values

src/api/DocumentEngineSchema.ts:17908

Method'get-document-form-field-widget'

* get-document-form-field-widget - Get a Widget * * Use this endpoint to get the widget with the specified ID from the document's default layer.

src/api/DocumentEngineSchema.ts:18357

Method'get-document-form-field-widgets'

* get-document-form-field-widgets - Get Widgets * * You can use this endpoint to fetch all widgets from the document's default layer.

src/api/DocumentEngineSchema.ts:18236

Method'get-document-form-fields'

* get-document-form-fields - Get Form Fields * * You can use this endpoint to fetch all form fields from the document's default layer.

src/api/DocumentEngineSchema.ts:18164

Method'get-document-instant-json'

* get-document-instant-json - Export Records as an Instant JSON * * Use this endpoint to export a document's records as an Instant JSON file. Th

src/api/DocumentEngineSchema.ts:17629

Method'get-document-layer-annotation'

* get-document-layer-annotation - Get an Annotation From a Layer

src/api/DocumentEngineSchema.ts:18567

Method'get-document-layer-annotations'

* get-document-layer-annotations - Get Annotations in a Layer * * You can use this endpoint to fetch all annotations from the given layer. *

src/api/DocumentEngineSchema.ts:18469

Method'get-document-layer-bookmarks'

* get-document-layer-bookmarks - Gets Layer's Bookmarks

src/api/DocumentEngineSchema.ts:18973

Method'get-document-layer-digital-signatures'

* get-document-layer-digital-signatures - Get Digital Signatures in a Layer * * Returns a layer's digital signatures. * * You can fetch th

src/api/DocumentEngineSchema.ts:18796

Method'get-document-layer-embedded-files'

* get-document-layer-embedded-files - Get Layers's Embedded Files * * Returned records describe files that are attached to a layer. * * Us

src/api/DocumentEngineSchema.ts:19026

Method'get-document-layer-form-field'

* get-document-layer-form-field - Get a Form Field in a Layer * * Use this endpoint to get the form field with a specified ID from a layer of th

src/api/DocumentEngineSchema.ts:19103

Method'get-document-layer-form-field-values'

* get-document-layer-form-field-values - Gets Layer's Form Field Values

src/api/DocumentEngineSchema.ts:18708

Method'get-document-layer-form-fields'

* get-document-layer-form-fields - Get Form Fields in a Layer * * You can use this endpoint to fetch all form fields from a document's layer.

src/api/DocumentEngineSchema.ts:19039

Method'get-document-layer-instant-json'

* get-document-layer-instant-json - Export Layer's Records as an Instant JSON

src/api/DocumentEngineSchema.ts:18817

Method'get-document-layer-page-annotations'

* get-document-layer-page-annotations - Get Annotations on a Page in a Layer * * You can use this endpoint to fetch annotations on the given pag

src/api/DocumentEngineSchema.ts:18556

Method'get-document-layer-page-highlighted-text'

* get-document-layer-page-highlighted-text - Get Highlighted Text on a Page in a Layer * * Highlighted text in the document refers to any text t

src/api/DocumentEngineSchema.ts:18917

Method'get-document-layer-page-text'

* get-document-layer-page-text - Get Text of a Page in a Layer

src/api/DocumentEngineSchema.ts:18900

Method'get-document-layer-text'

* get-document-layer-text - Fetch Document Text * * This endpoint allows you to fetch the text of all pages in a document.

src/api/DocumentEngineSchema.ts:18890

Method'get-document-layer-widget'

* get-document-layer-widget - Get a Widget in a Layer * * Use this endpoint to get the widget with the specified ID from a layer of the document

src/api/DocumentEngineSchema.ts:19174

Method'get-document-layer-widgets'

* get-document-layer-widgets - Get Widgets in a Layer * * You can use this endpoint to fetch all widgets from a layer of the documents. * The

src/api/DocumentEngineSchema.ts:19118

Method'get-document-layer-xfdf'

* get-document-layer-xfdf - Export Layer's Annotations as an XFDF

src/api/DocumentEngineSchema.ts:18807

Method'get-document-outline'

* get-document-outline - Get a Document Outline * * This endpoint allows you to fetch the outline of a document.

src/api/DocumentEngineSchema.ts:17296

Method'get-document-page-annotations'

* get-document-page-annotations - Fetch Annotations on a Page * * You can use this endpoint to fetch annotations on the given page from the docu

src/api/DocumentEngineSchema.ts:17856

Method'get-document-page-highlighted-text'

* get-document-page-highlighted-text - Fetch Highlighted Text on a Page * * Highlighted text in the document refers to any text that is highligh

src/api/DocumentEngineSchema.ts:17393

Method'get-document-page-text'

* get-document-page-text - Fetch Page Text * * This endpoint allows you to fetch the text of a specific page in a document.

src/api/DocumentEngineSchema.ts:17377

Method'get-document-text'

* get-document-text - Fetch Document Text * * This endpoint allows you to fetch the text of all pages in a document.

src/api/DocumentEngineSchema.ts:17365

Method'get-document-xfdf'

* get-document-xfdf - Export Annotations as an XFDF

src/api/DocumentEngineSchema.ts:17611

Method'get-font-substitutions'

* get-font-substitutions - Get font substitutions * * This endpoint allows you to get font substitutions that were set for the specific document

src/api/DocumentEngineSchema.ts:18312

Method'get-font-substitutions-in-layer'

* get-font-substitutions-in-layer - Get font substitutions * * This endpoint allows you to get font substitutions that were set for the specific

src/api/DocumentEngineSchema.ts:19207

Method'get-fonts'

* get-fonts - Get fonts

src/api/DocumentEngineSchema.ts:18291

Method'get-fonts-in-layer'

* get-fonts-in-layer - Get fonts

src/api/DocumentEngineSchema.ts:19184

Method'get-global-fonts'

* get-global-fonts - Get global fonts

src/api/DocumentEngineSchema.ts:17261

← previous next →201–300 of 448, ranked by callers