Subscribe

UiPath Document Understanding

UiPath Document Understanding

Public Endpoints

Depending on your license which is verified based on your API key, there are two types of limitations available for each ML Package:

  • Community licensed traffic - The size of documents that can be extracted is limited to 2 pages and 4MB and there is a rate-limiting per account at 50 requests per hour. When an account reaches the rate limit, the server responds with 429 - Too Many Requests error status. Community Edition license of Document Understanding has no quantity displayed on the Licenses page within the Document Understanding section.

  • Enterprise licensed traffic - The consumption entitlement is displayed as a number of pages on the Licenses page within the Document Understanding section. The size of documents that can be extracted is limited per page to 20 megapixels and 10MB, in JSON-Base64 format.

❗️

Deprecated Public Endpoints

All public endpoints, except for UiPath Document OCR, FormExtractor, IntelligentFormExtractor, and IntelligentKeywordClassifier, are deprecated for non-West Europe regions since December 6, 2021.

Make sure you connect your activity to the correct endpoint according to each server region.

ML Package

Endpoint

UiPathDocumentOCR

https://du.uipath.com/ocr

Invoices

https://du.uipath.com/ie/invoices

InvoicesAustralia

https://du.uipath.com/ie/invoices_au

InvoicesIndia

https://du.uipath.com/ie/invoices_india

InvoicesJapan (Preview)

https://du.uipath.com/ie/invoices_japan

InvoicesChina (Preview)

https://du.uipath.com/ie/invoices_china

Receipts

https://du.uipath.com/ie/receipts

PurchaseOrders

https://du.uipath.com/ie/purchase_orders

UtilityBills

https://du.uipath.com/ie/utility_bills

IDCards (Preview)

https://du.uipath.com/ie/id_cards

Passports

https://du.uipath.com/ie/passports

Legal Contracts (Preview)

https://du.uipath.com/ie/contracts_preview

ML Classification (Preview)

https://du.uipath.com/classify/MLclassification

RemittanceAdvices (Preview)

https://du.uipath.com/ie/remittance_advices

DeliveryNotes (Preview)

https://du.uipath.com/ie/delivery_notes

W2 (Preview)

https://du.uipath.com/ie/w2

W9

https://du.uipath.com/ie/w9

ChineseJapaneseKoreanOCR

https://du.uipath.com/cjk-ocr

ACORD125 (Preview)

https://du.uipath.com/ie/acord125

I9 (Preview)

https://du.uipath.com/ie/i9

990 (Preview)

https://du.uipath.com/ie/990

4506T (Preview)

https://du.uipath.com/ie/4506t

FM1003 (Preview)

https://du.uipath.com/ie/fm1003

FormExtractor

https://du.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du.uipath.com/svc/intelligentkeywords

Public Preview Models - New AI Architecture
Invoices Preview

https://du.uipath.com/ie/invoices_preview

InvoicesAustralia Preview

https://du.uipath.com/ie/invoices_au_preview

InvoicesIndia Preview

https://du.uipath.com/ie/invoices_india_preview

Receipts Preview

https://du.uipath.com/ie/receipts_preview

PurchaseOrders Preview

https://du.uipath.com/ie/purchase_orders_preview

UtilityBills Preview

https://du.uipath.com/ie/utility_bills_preview

IDCards Preview

https://du.uipath.com/ie/id_cards_preview

Passports Preview

https://du.uipath.com/ie/passports_preview

RemittanceAdvices Preview

https://du.uipath.com/ie/remittance_advices_preview

DeliveryNotes Preview

https://du.uipath.com/ie/delivery_notes_preview

W2 Preview

https://du.uipath.com/ie/w2_preview

W9 Preview

https://du.uipath.com/ie/w9_preview

ACORD125 Preview

https://du.uipath.com/ie/acord125_preview

I9 Preview

https://du.uipath.com/ie/i9_preview

990 Preview

https://du.uipath.com/ie/990_preview

4506T Preview

https://du.uipath.com/ie/4506t_preview

FM1003 Preview

https://du.uipath.com/ie/fm1003_preview

ML Package

Endpoint

UiPathDocumentOCR

https://du-au.uipath.com/ocr

Invoices deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/invoices

InvoicesAustralia deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/invoices_au

InvoicesIndia deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/invoices_india

InvoicesJapan (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/invoices_japan

Receipts deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/receipts

PurchaseOrders deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/purchase_orders

UtilityBills (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/utility_bills

IDCards (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/id_cards

Passports (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-au.uipath.com/ie/passports

Legal Contracts (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-aus.uipath.com/ie/contracts_preview

FormExtractor

https://du-au.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du-au.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du-au.uipath.com/svc/intelligentkeywords

ML Package

Endpoint

UiPathDocumentOCR

https://du-us.uipath.com/ocr

Invoices deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/invoices

InvoicesAustralia deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/invoices_au

InvoicesIndia deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/invoices_india

InvoicesJapan (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/invoices_japan

Receipts deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/receipts

PurchaseOrders deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/purchase_orders

UtilityBills (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/utility_bills

IDCards (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/id_cards

Passports (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/passports

Legal Contracts (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-us.uipath.com/ie/contracts_preview

FormExtractor

https://du-us.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du-us.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du-us.uipath.com/svc/intelligentkeywords

ML Package

Endpoint

UiPathDocumentOCR

https://du-ca.uipath.com/ocr

Invoices deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/invoices

InvoicesAustralia deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/invoices_au

InvoicesIndia deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/invoices_india

InvoicesJapan (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/invoices_japan

Receipts deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/receipts

PurchaseOrders deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/purchase_orders

UtilityBills (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/utility_bills

IDCards (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/id_cards

Passports (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/passports

Legal Contracts (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-ca.uipath.com/ie/contracts_preview

FormExtractor

https://du-ca.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du-ca.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du-ca.uipath.com/svc/intelligentkeywords

ML Package

Endpoint

UiPathDocumentOCR

https://du-jp.uipath.com/ocr

Invoices deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/invoices

InvoicesAustralia deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/invoices_au

InvoicesIndia deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/invoices_india

InvoicesJapan (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/invoices_japan

Receipts deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/receipts

PurchaseOrders deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/purchase_orders

UtilityBills (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/utility_bills

IDCards (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/id_cards

Passports (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/passports

Legal Contracts (Preview) deprecated since December 6, 2021; use the West Europe link

https://du-jp.uipath.com/ie/contracts_preview

ChineseJapaneseKoreanOCR

https://du-jp.uipath.com/cjk-ocr

FormExtractor

https://du-jp.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du-jp.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du-jp.uipath.com/svc/intelligentkeywords

ML Package

Endpoint

UiPathDocumentOCR

https://du-sg.uipath.com/ocr

ChineseJapaneseKoreanOCR

https://du-sg.uipath.com/cjk-ocr

FormExtractor

https://du-sg.uipath.com/svc/formextractor

IntelligentFormExtractor

https://du-sg.uipath.com/svc/intelligentforms

IntelligentKeywordClassifier

https://du-sg.uipath.com/svc/intelligentkeywords

🚧

Warning!

Having an Enterprise licensing plan on your Automation Cloud does not imply that you have access to the Enterprise licensed traffic for Document Understanding. Access to the Enterprise licensed traffic is subject to a different, separate license.

Updated 29 days ago


Public Endpoints


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.