PrizmDoc Server API

PrizmDoc Server API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Accusoft.

PrizmDoc Server API | Accusoft Workspace | API documentation

Accusoft-Affinity-Token

Associate a Work File with a Viewing Session

Associate a Work File with a Viewing Session Viewing Session PrizmDoc Server API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Accusoft.

Associate a Work File with a Viewing Session Viewing Session PrizmDoc Server API | Accusoft Workspace | API documentation

Viewing Session

Viewing Session PrizmDoc Server API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Accusoft.

Viewing Session PrizmDoc Server API | Accusoft Workspace | API documentation

Start a Barcode Scanner

Get the status of a Barcode Scanner

Barcode Xpress API

Get Health

Administration

Delete Workbook

Download Workbook

Upload Workbook

Documents

Sessions-Document

Create a Session

Sessions

Cells API

Add Document Comments

Delete Document Comments

Get Document Comments

Update Document Comments

Documents-Comments

Find and Replace Text (Beta)

Get Document Text (Beta)

Documents-Text

Upload Document

Clone Document

Delete Document

Download Document

Download Session Document

Delete Session

Get Default Session Configuration

Set Default Session Configuration

Editor API

Start an Image Editor Process

Get the status of an Image Editor Process

ImageGear API

Get Info

Get Services Connection

Administration (Self-Hosted)

Get Document Attributes

Get Document Text

Document

Get all Form Definitions

Get a Form Definition

Create a Form Definition

Delete a Form Definition

Form Definitions

Start a Form Extraction

Get the Status/Results of a Form Extraction

Form Extractors

Get all Image Stamps

Get an Image Stamp

Image Stamp

Get all Markup Layers

Create a Markup Layer

Get a Markup Layer Record

Delete a Markup Layer Record

Update a Markup Layer Record

Markup Layers

Get Page

Get Page Thumbnail

Get Page Attributes

Get Page Tile

Page

Get a Viewing Package Creator (Requires the feature to be enabled)

Create a Viewing Package Creator (Requires the feature to be enabled)

Update a Viewing Package Creator (Requires the feature to be enabled)

Viewing Package Creators (Requires the feature to be enabled)

Get a Viewing Package (Requires the feature to be enabled)

Delete a Viewing Package (Requires the feature to be enabled)

Get a Viewing Package's Viewing Package Creator (Requires the feature to be enabled)

Viewing Packages (Requires the feature to be enabled)

Get Attachments

Viewing Sessions-Attachments

Start a Content Conversion

Get the Status of a Content Conversion

Get the Result of a Content Conversion

Viewing Sessions-Content Converters

Get Form Info

Viewing Sessions-Form Info

Start a Markup Burn

Get the Status of a Markup Burn

Get the Result of a Markup Burn

Viewing Sessions-Markup Burner

Start a Search Task

Get a Search Task

Delete a Search Task

Viewing Sessions-Search Tasks

Upload the Original File (This call is dependent on a .docx file not included in this collection)

Get the Original File (This call is dependent on a .docx file not included in this collection)

Upload the Revised File (This call is dependent on a .docx file not included in this collection)

Get the Revised File (This call is dependent on a .docx file not included in this collection)

Viewing Sessions-Comparison (Requires a Windows Server with Microsoft Office)

Create a Viewing Session

Upload a File to a Viewing Session

Get the Viewing Session's Work File

Viewing Sessions

PrizmDoc Application Services (PAS) API

Get Admin

Get Servers

Update Servers

Content Converters

Get the Status/Result of a Markup Burn

Markup Burner

Create a Plain Text Redactor

Get the Status of a Plain Text Redactor

Plain Text Redactors

Create a Redaction Creator

Get the Status of a Redaction Creator

Redaction Creators

Create a Search Context

Get a Search Context

Delete a Search Context

Upload Records to a Search Context

Signal That All Records Have Been Uploaded

Get the Records of a Search Context

Search Contexts

Get Search Task Metadata

Get the Results of a Search Task

Search Tasks

Viewing Session-Markup Burner

Upload the Original Document (This call is dependent on a .docx file not included in this collection)

Get the Original Document (This call is dependent on a .docx file not included in this collection)

Upload the Revised Document (This call is dependent on a .docx file not included in this collection)

Get the Revised Document (This call is dependent on a .docx file not included in this collection)

Get the Revision Data (This call is dependent on a .docx file not included in this collection)

Viewing Session-Comparison (Requires a Windows Server with Microsoft Office)

Viewing Session-Search Tasks

Get Viewing Session Metadata

Get a Viewing Session's Work File ID

Get the Work File Associated with a Viewing Session

Delete a Viewing Session

Create a Work File

Get a Work File

Get a Work File's Metadata

Work File

1) Create a Viewing Session

PrizmDoc API-Create a Viewing Session

1) Create a Work File

PrizmDoc API-Create a Work File

2) Create a Work File for the Markup

3) Start a Markup Burn

4) Get the Status/Result of a Markup Burn

5) Download the final Document

PrizmDoc API-Burn Markup

1) Create a Work File for the Document

2) Start a Content Conversion

3) Get the Status of the conversion to PDF

4) Download the final Document

PrizmDoc API-Convert to PDF

2) Start a Content Conversion (Selecting Pages to Keep)

PrizmDoc API-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection)

2) Create a Work File for the Second Document

3) Start a Content Conversion

4) Get the Status of the conversion to PDF

PrizmDoc API-Merging Documents Together

3) Get the Status of the conversion to TIFF

PrizmDoc API-Convert to TIFF

4) Start a Content Conversion back to PDF

5) Get the Status of the conversion back to PDF

6) Download the Final Document

PrizmDoc API-Securely Redact a PDF Document (This call is dependent on a .pdf file not included in this collection)

1) Create a Work File for the Raster Document (This call is dependent on a .tif file not included in this collection)

PrizmDoc API-Create a Searchable PDF via OCR (This call is dependent on a .tif file not included in this collection)

2) Create Markup JSON from a Regex pattern

3) Get the status of the Markup Creation

4) Start a Markup Burn

5) Get the status/result of a Markup Burn

6) Download the final Document

PrizmDoc API-Perform Auto-Redaction

2) Create a Search Context

3) Get the status of the Search Context

4) Get full-page text data (records)

PrizmDoc API-Extracting Text from a Document (Search Context)

4) Start a full-text search against a Search Context

5) Get the status of the full-text search

6) Get available search results

PrizmDoc API-Searching Text of a Document (Search Tasks)

2) Upload a File to a Viewing Session

3) View the Watermark on the Document

PrizmDoc API-Watermark Content for use in a Viewing Session

1) Create a Work File for the Image File

2) Start an Image Editor Process

3) Get the Status of the Image Editor Process

4) Download the Resulting Image

Image Editor API-Flip Image (This call is dependent on a .png file not included in this collection)

Image Editor API-Crop Image (This call is dependent on a .png file not included in this collection)

Image Editor API-Resize Image (This call is dependent on a .png file not included in this collection)

Image Editor API-Rotate Image (This call is dependent on a .png file not included in this collection)

Image Editor API-Convert Color Space of an Image (This call is dependent on a .png file not included in this collection)

1) Create a Work File for the Barcode Image

2) Start a Barcode Scanner Process

3) Get the Status and the Result of the Barcode Scanner Process

Barcode Scanner API-Obtain Barcode Scanner Results (This call is dependent on a .png file not included in this collection)

Workflows

<p>Currently, the collections demonstrate the following APIs:</p>

<ul>
<li>PrizmDoc Server</li>
<li>PrizmDoc Application Services (PAS)</li>
<li>PrizmDoc Editor</li>
<li>PrizmDoc Cells</li>
<li>Barcode Scanner</li>
<li>Image Editor</li>
</ul>

<p>You will also find a <q>Workflows</q> collection, which features some of our most common use-cases.</p>

<p>If you’re getting started, please see <a href="https://help.accusoft.com/PrizmDoc/latest/HTML/configure-Qodex-collections.html">our guide</a> for important information about configuring and using the collections.</p>

<p>We&#39;re continuing to improve our Qodex Collections; please let us know if there&#39;s something you&#39;d like to see added, or have any other feedback at <a href="mailto:Qodex@accusoft.com">Qodex@accusoft.com</a></p>

<h3>For more information:</h3>

<ul>
<li><a href="https://help.accusoft.com/PrizmDoc/latest/HTML/dev-guide-use-prizmdoc-server-api.html">Using PrizmDoc Server</a></li>
<li><a href="https://help.accusoft.com/PrizmDoc/latest/HTML/pas-dev-guide-overview.html">Using PrizmDoc Application Services (PAS)</a></li>
<li><a href="https://api.accusoft.com/editor/docs/">Using PrizmDoc Editor</a></li>
<li><a href="https://api.accusoft.com/cells/docs/">Using PrizmDoc Cells</a></li>
<li><a href="https://help.accusoft.com/BarcodeXpress/v13.10/BxNetCore/try-the-rest-api.html">Using the Barcode Scanner</a></li>
<li><a href="https://help.accusoft.com/ImageGear/v26.4/try-the-rest-api.html">Using the Image Editor</a></li>
</ul>

<h3>API Documentation:</h3>

<ul>
<li><a href="https://help.accusoft.com/PrizmDoc/latest/HTML/api-reference.html">PrizmDoc Viewer API Reference</a></li>
<li><a href="https://api.accusoft.com/editor/docs/#api-Documents-uploadDocument">PrizmDoc Editor API Reference</a></li>
<li><a href="https://api.accusoft.com/cells/docs/#api-Admin-getHealth">PrizmDoc Cells API Reference</a></li>
<li><a href="https://help.accusoft.com/BarcodeXpress/v13.10/BxNetCore/rest-api.html">Barcode Scanner API Reference</a></li>
<li><a href="https://help.accusoft.com/ImageGear/v26.3/rest-api-image-editor.html">Image Editor API Reference</a></li>
</ul>

<h6>To learn more, please visit <a href="https://www.accusoft.com/">accusoft.com</a>.</h6>


Accusoft

Accusoft projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Accusoft.

Accusoft APIs | Accusoft API Integration | QodexAI API Network

Key	Datatype	Required	Description
Accusoft-Affinity-Token	string