Connectors Reference

Docparser

Extract data from PDF files & automate your workflow with our reliable document parsing software.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

ParserList ()

Get a list of document parsers

UploadDocument (string parser_id, file file, [advanced][Optional]string remote_id)

Upload a document to Docparser

FetchDocument (string parser_id, string url, [advanced][Optional]string remote_id)

Fetch document from a URL

GetResultSchema (string parser_id)

Show the schema of parsed data of last document

WebhookDelete (string parser_id, string webhook_id)

Delete a Docparser webhook

 

Triggers:

Name

Summary

WebhookCreate (string parser_id, [Optional]WebhookCreate target_url)

New parsed document data is available

 

Objects:

Name

Summary

FetchDocumentResponse

 

file

File Content

GetResultSchemaResponse

 

Parser

 

UploadDocumentResponse

 

WebhookCreate

 

WebhookCreateReponse

 

WebhookDeleteResponse

 

 

Actions:

ParserList

Summary: Get a list of document parsers

Description: This endpoint returns a list of all Document Parsers linked to your account. Each entry contains an id and a label. The id value an be used in other API routes, e.g. for importing documents to a specific Document Parser or obtaining parsing results.

 

Syntax:

Docparser.ParserList ()

 

Returns:

          Type:array of (Parser)

 

UploadDocument

Summary: Upload a document to Docparser

Description: Uploading a document to Docparser works like uploading a file with a HTML form. All you need to do is to send a form-data request to the API endpoint containing the document in the form field file.The return value of a successful upload is the ID of the newly created document, the filesize of the imported document as well as account usage data.

 

Syntax:

Docparser.UploadDocument (string parser_id, file file, [advanced][Optional]string remote_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

parser_id

string

(Your Document Parser)

Enter parser id.

True

ParserList

file

file

(File Content)

The file to upload.

True

remote_id

string

(Remote Id)

Optional parameter to pass through your own document ID.

False

 

Returns:

          Type:UploadDocumentResponse

 

FetchDocument

Summary: Fetch document from a URL

Description: If your files are stored under a publicly accessible URL, you can also import a document by providing the URL to our API. This method is really straight forward and you just need to perform a simple POST or GET request with url as the parameter.

 

Syntax:

Docparser.FetchDocument (string parser_id, string url, [advanced][Optional]string remote_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

parser_id

string

(Your Document Parser)

Enter parser id.

True

ParserList

url

string

(Url)

The location of a publicly accessible document.

True

remote_id

string

(Remote Id)

Optional parameter to pass through your own document ID.

False

 

Returns:

          Type:FetchDocumentResponse

 

GetResultSchema

Summary: Show the schema of parsed data of last document

Description: Returns the schema of the parsed data.

 

Syntax:

Docparser.GetResultSchema (string parser_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

parser_id

string

(Your Document Parser)

Enter parser id.

True

ParserList

 

Returns:

          Type:GetResultSchemaResponse

 

WebhookDelete

Summary: Delete a Docparser webhook

Description: Delete a Docparser webhook.

 

Syntax:

Docparser.WebhookDelete (string parser_id, string webhook_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

parser_id

string

 

 

True

webhook_id

string

 

 

True

 

Returns:

          Type:WebhookDeleteResponse

 

Triggers:

Trigger WebhookCreate

Summary: New parsed document data is available

Description: Creates a Docparser webhook.

 

Syntax:

Docparser.WebhookCreate (string parser_id, [Optional]WebhookCreate target_url)

 

Parameters:

Name

Type

Summary

Required

Related Action

parser_id

string

(Your Document Parser)

Enter parser id.

True

ParserList

target_url

WebhookCreate

 

 

False

 

Returns:

          Type:WebhookCreateReponse

 


 

FetchDocumentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique identifier of the document.

file_size

integer

Size

File size of the fetched document.

quota_used

integer

Quota Used

Part of the quota used.

quota_left

integer

Quota Left

Part of the quota left.

quota_refill

string

Quota Refill

Updated date-time of the quota.


 

file

Summary: File Content

Description: The file to upload.

 

          Properties:

Name

Type

Summary


 

GetResultSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Parser

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique identifier of the parser.

label

string

Label

Description of the parser.


 

UploadDocumentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique identifier of the document.

file_size

integer

Size

File size of the uploaded document.

quota_used

integer

Quota Used

Part of the quota used for file upload.

quota_left

integer

Quota Left

Part of the quota left after file upload.

quota_refill

string

Quota Refill

Updated date-time of the quota.


 

WebhookCreate

Summary:

Description:

 

          Properties:

Name

Type

Summary

target_url

string

 

 


 

WebhookCreateReponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhook_id

string

 

 

parser_id

string

 

 


 

WebhookDeleteResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary