Barcode Xpress API

Start a Barcode Scanner Get the status of a Barcode Scanner

Delete Workbook Download Workbook Upload Workbook

Sessions-Document

Download Workbook

Create a Session

Documents-Comments

Add Document Comments Delete Document Comments Get Document Comments Update Document Comments

Find and Replace Text (Beta)Get Document Text (Beta)

Upload Document Clone Document Delete Document Download Document

Sessions-Document

Download Document Download Session Document

Create a Session Delete Session Get Default Session Configuration Set Default Session Configuration

Start an Image Editor Process Get the status of an Image Editor Process

PrizmDoc Application Services (PAS) API

Administration (Self-Hosted)

Get Health Get Info Get Services Connection

Get Document Attributes Get Document Text

Form Definitions

Get all Form Definitions Get a Form Definition Create a Form Definition Delete a Form Definition

Form Extractors

Start a Form Extraction Get the Status/Results of a Form Extraction

Get all Image Stamps Get an 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

Get Page Get Page Thumbnail Get Page Attributes Get Page Tile

Viewing Package Creators (Requires the feature to be enabled)

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 Packages (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 Sessions-Attachments

Get Attachments

Viewing Sessions-Content Converters

Start a Content Conversion Get the Status of a Content Conversion Get the Result of a Content Conversion

Viewing Sessions-Form Info

Viewing Sessions-Markup Burner

Start a Markup Burn Get the Status of a Markup Burn Get the Result of a Markup Burn

Viewing Sessions-Search Tasks

Start a Search Task Get a Search Task Delete a Search Task

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

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

Create a Viewing Session Upload a File to a Viewing Session Get the Viewing Session's Work File

PrizmDoc Server API

Administration (Self-Hosted)

Get Admin Get Health Get Info Get Servers Update Servers

Content Converters

Start a Content Conversion Get the Status of a Content Conversion

Get Document Text Get Document Attributes

Start a Markup Burn Get the Status/Result of a Markup Burn

Get Page Get Page Thumbnail Get Page Attributes Get Page Tile

Plain Text Redactors

Create a Plain Text Redactor Get the Status of a Plain Text Redactor

Redaction Creators

Create a Redaction Creator Get the Status of a Redaction Creator

Search Contexts

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

Start a Search Task Get Search Task Metadata Delete a Search Task Get the Results of a Search Task

Viewing Session-Markup Burner

Start a Markup Burn Get the Status of a Markup Burn Get the Result of a Markup Burn

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

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-Search Tasks

Start a Search Task

Viewing Session

Create a Viewing Session Get Viewing Session Metadata Get a Viewing Session's Work File ID Upload a File to a Viewing Session Associate a Work File with a Viewing Session 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

PrizmDoc API-Create a Viewing Session

1) Create a Viewing Session

PrizmDoc API-Create a Work File

1) Create a Work File

PrizmDoc API-Burn Markup

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-Convert to PDF

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-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection)

1) Create a Work File for the Document 2) Start a Content Conversion (Selecting Pages to Keep)3) Get the Status of the conversion to PDF 4) Download the final Document

PrizmDoc API-Merging Documents Together

2) Create a Work File for the Second Document 3) Start a Content Conversion 4) Get the Status of the conversion to PDF 5) Download the final Document

PrizmDoc API-Convert to TIFF

1) Create a Work File for the Document 2) Start a Content Conversion 3) Get the Status of the conversion to TIFF 4) 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 Document 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-Create a Searchable PDF via OCR (This call is dependent on a .tif 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)2) Start a Content Conversion 3) Get the Status of the conversion to PDF 4) Download the final Document

PrizmDoc API-Perform Auto-Redaction

1) Create a Work File for the Document 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-Extracting Text from a Document (Search Context)

1) Create a Work File for the Document 2) Create a Search Context 3) Get the status of the Search Context 4) Get full-page text data (records)

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

1) Create a Work File for the Document 2) Create a Search Context 3) Get the status of the 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-Watermark Content for use in a Viewing Session

1) Create a Viewing Session 2) Upload a File to a Viewing Session 3) View the Watermark on the Document

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

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-Crop Image (This call is dependent on a .png file not included in this collection)

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-Resize Image (This call is dependent on a .png file not included in this collection)

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-Rotate Image (This call is dependent on a .png file not included in this collection)

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-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 Image File 2) Start an Image Editor Process 3) Get the Status of the Image Editor Process 4) Download the Resulting Image

Barcode Scanner API-Obtain Barcode Scanner Results (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 Xpress API

Start a Barcode Scanner Get the status of a Barcode Scanner

Delete Workbook Download Workbook Upload Workbook

Sessions-Document

Download Workbook

Create a Session

Documents-Comments

Add Document Comments Delete Document Comments Get Document Comments Update Document Comments

Find and Replace Text (Beta)Get Document Text (Beta)

Upload Document Clone Document Delete Document Download Document

Sessions-Document

Download Document Download Session Document

Create a Session Delete Session Get Default Session Configuration Set Default Session Configuration

Start an Image Editor Process Get the status of an Image Editor Process

PrizmDoc Application Services (PAS) API

Administration (Self-Hosted)

Get Health Get Info Get Services Connection

Get Document Attributes Get Document Text

Form Definitions

Get all Form Definitions Get a Form Definition Create a Form Definition Delete a Form Definition

Form Extractors

Start a Form Extraction Get the Status/Results of a Form Extraction

Get all Image Stamps Get an 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

Get Page Get Page Thumbnail Get Page Attributes Get Page Tile

Viewing Package Creators (Requires the feature to be enabled)

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 Packages (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 Sessions-Attachments

Get Attachments

Viewing Sessions-Content Converters

Start a Content Conversion Get the Status of a Content Conversion Get the Result of a Content Conversion

Viewing Sessions-Form Info

Viewing Sessions-Markup Burner

Start a Markup Burn Get the Status of a Markup Burn Get the Result of a Markup Burn

Viewing Sessions-Search Tasks

Start a Search Task Get a Search Task Delete a Search Task

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

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

Create a Viewing Session Upload a File to a Viewing Session Get the Viewing Session's Work File

PrizmDoc Server API

Administration (Self-Hosted)

Get Admin Get Health Get Info Get Servers Update Servers

Content Converters

Start a Content Conversion Get the Status of a Content Conversion

Get Document Text Get Document Attributes

Start a Markup Burn Get the Status/Result of a Markup Burn

Get Page Get Page Thumbnail Get Page Attributes Get Page Tile

Plain Text Redactors

Create a Plain Text Redactor Get the Status of a Plain Text Redactor

Redaction Creators

Create a Redaction Creator Get the Status of a Redaction Creator

Search Contexts

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

Start a Search Task Get Search Task Metadata Delete a Search Task Get the Results of a Search Task

Viewing Session-Markup Burner

Start a Markup Burn Get the Status of a Markup Burn Get the Result of a Markup Burn

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

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-Search Tasks

Start a Search Task

Viewing Session

Create a Viewing Session Get Viewing Session Metadata Get a Viewing Session's Work File ID Upload a File to a Viewing Session Associate a Work File with a Viewing Session 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

PrizmDoc API-Create a Viewing Session

1) Create a Viewing Session

PrizmDoc API-Create a Work File

1) Create a Work File

PrizmDoc API-Burn Markup

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-Convert to PDF

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-Selecting Pages to Keep after Conversion (This call is dependent on a .docx file not included in this collection)

1) Create a Work File for the Document 2) Start a Content Conversion (Selecting Pages to Keep)3) Get the Status of the conversion to PDF 4) Download the final Document

PrizmDoc API-Merging Documents Together

2) Create a Work File for the Second Document 3) Start a Content Conversion 4) Get the Status of the conversion to PDF 5) Download the final Document

PrizmDoc API-Convert to TIFF

1) Create a Work File for the Document 2) Start a Content Conversion 3) Get the Status of the conversion to TIFF 4) 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 Document 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-Create a Searchable PDF via OCR (This call is dependent on a .tif 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)2) Start a Content Conversion 3) Get the Status of the conversion to PDF 4) Download the final Document

PrizmDoc API-Perform Auto-Redaction

1) Create a Work File for the Document 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-Extracting Text from a Document (Search Context)

1) Create a Work File for the Document 2) Create a Search Context 3) Get the status of the Search Context 4) Get full-page text data (records)

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

1) Create a Work File for the Document 2) Create a Search Context 3) Get the status of the 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-Watermark Content for use in a Viewing Session

1) Create a Viewing Session 2) Upload a File to a Viewing Session 3) View the Watermark on the Document

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

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-Crop Image (This call is dependent on a .png file not included in this collection)

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-Resize Image (This call is dependent on a .png file not included in this collection)

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-Rotate Image (This call is dependent on a .png file not included in this collection)

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-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 Image File 2) Start an Image Editor Process 3) Get the Status of the Image Editor Process 4) Download the Resulting Image

Barcode Scanner API-Obtain Barcode Scanner Results (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

Home WorkflowsPrizmDoc API-Create a Work File

PrizmDoc API-Create a Work File

Number of APIs: 1

1) Create a Work File POST {{prizmdoc_server_base_url}}/PCCIS/V1/WorkFile?FileExtension={{fileExtension}}

1) Create a Viewing Session

1) Create a Work File