Docparser

Docparser integration (Productivity, Data). Imported from open-connector.

API key10 toolshttps://api.docparser.com

GET

docparser_ping

Ping the Docparser API to verify that the provided API key is valid.

/v1/ping

GET

docparser_list_parsers

List all Document Parsers linked to the current Docparser account.

/v1/parsers

GET

docparser_get_parser_models

List all model layouts for a specific Docparser parser.

/v1/parser/models/{parserId}

1 parameter

Param	Type	Required	Description
parserId	string	required	The parser identifier to list model layouts for.

POST

docparser_upload_document_by_content

Upload a document to a Docparser parser by sending base64-encoded file content and an optional file name.

/v1/document/upload/{parserId}

4 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier to upload the document to.
contentBase64	string	required	The base64-encoded document content to upload.
fileName	string	optional	The file name to attribute to the uploaded document.
remoteId	string	optional	An optional passthrough ID that is stored with the document.

POST

docparser_fetch_document_from_url

Queue a publicly accessible document URL for import into a Docparser parser and return the scheduled document metadata.

/v2/document/fetch/{parserId}

3 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier to import the document into.
url	string	required	The publicly accessible document URL to fetch.
remoteId	string	optional	An optional passthrough ID that is stored with the fetched document.

GET

docparser_get_document_status

Retrieve the import, preprocessing, parsing, and webhook-dispatch status of one Docparser document.

/v2/document/status/{parserId}/{documentId}

2 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier that owns the document.
documentId	string	required	The unique document identifier returned during import.

GET

docparser_get_document_result

Retrieve the parsed data of one Docparser document. When child documents exist and are included, multiple result rows may be returned.

/v1/results/{parserId}/{documentId}

4 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier that owns the document.
documentId	string	required	The unique document identifier returned during import.
format	string	optional	The output format for parsed data. `object` returns nested JSON and `flat` retu…
includeChildren	boolean	optional	Whether parsed data of child documents should also be returned.

GET

docparser_get_multiple_document_results

Retrieve parsed data for multiple documents of a specific parser with optional filtering, pagination, queue inclusion, and sorting.

/v1/results/{parserId}

9 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier to read results from.
format	string	optional	The output format for parsed data. `object` returns nested JSON and `flat` retu…
list	string	optional	The upstream result list mode used to filter which documents are returned.
limit	integer	optional	The maximum number of result rows to return.
date	string	optional	The ISO 8601 or Unix timestamp filter used with `uploaded_after` or `processed_…
remoteId	string	optional	Restrict results to documents with this remote ID.
includeProcessingQueue	boolean	optional	Whether in-progress documents should also be included in the result set.
sortBy	string	optional	The timestamp field used to sort multiple-document results.
sortOrder	string	optional	The sort direction used for multiple-document results.

POST

docparser_reparse_documents

Schedule one or more Docparser documents for re-parsing using their document IDs.

/v1/document/reparse/{parserId}

2 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier that owns the documents.
documentIds	array	optional	The document identifiers to schedule for re-parsing.

POST

docparser_reintegrate_documents

Schedule one or more Docparser documents for the integration queue using their document IDs.

/v1/document/reintegrate/{parserId}

2 parameters

Param	Type	Required	Description
parserId	string	required	The parser identifier that owns the documents.
documentIds	array	optional	The document identifiers to schedule for reintegration.