document-understanding
latest
false
  • Getting Started
    • Overview
    • Limits and Quota
  • Examples Using the Document Understanding™ Cloud API
  • Licensing
  • Troubleshooting
Document Understanding API Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Oct 21, 2024

Start the extraction fields request

Start extracting fields from a document

Tip: The Project ID is obtained from the response received from the Get project information call.
curl -X 'POST' \
  'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/extractors/invoices/extraction/start?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkY5QTYwNUMxRDlFOEQyNzFGNTZBOEE4NzI2NTgzMURBRjkyMkQ5ODAiLCJ4NXQiOiItYVlGd2RubzBuSDFhb3FISmxneDJ2a2kyWUEiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3N0YWdpbmcudWlwYXRoLmNvbS9pZGVudGl0eV8iLCJuYmYiOjE3MTE2Mzc3NDQsImlhdCI6MTcxMTYzODA0NCwiZXhwIjoxNzExNjQxNjQ0LCJhdWQiOiJVaVBhdGguRG9jdW1lbnRVbmRlcnN0YW5kaW5nIiwic2NvcGUiOlsiRHUuQ2xhc3NpZmljYXRpb24uQXBpIiwiRHUuRGlnaXRpemF0aW9uLkFwaSIsIkR1LkV4dHJhY3Rpb24uQXBpIiwiRHUuVmFsaWRhdGlvbi5BcGkiXSwic3ViX3R5cGUiOiJzZXJ2aWNlLmV4dGVybmFsIiwicHJ0X2lkIjoiOTViYWY3YTItNTljNC00NDM4LTkzYmItNTU5NjdmMTA0OTA0IiwiY2xpZW50X2lkIjoiNzI4MWU5OTgtZjczMC00MDVmLThmNTQtMzQ1NWQyMzJmZjA0IiwianRpIjoiOUQ0ODhBMDczQkEyNjVEQTNCNjNCMTU0OTdGQkQ0M0IifQ.ij6SIKi1aT3TrsSP3JVzOomhyESKVgSd4KQlU_PyRBI3gaLbtS3CIM0tmIuaXpKhwrIpTjPbXRLzF0nzu7u7YX7ICTmMO3hL_Ym3EXB9rGDJSlHyiunwEq-6RMyOq3I7naKEQv5ZOHK9lksgH3OWRN8CmsBynuJR59WBjDbkd8tVwiHdkfYS4EJ2FsDM6f4otIpJ4DJ0xqf95eVF7b4H1VciSNJ2pYeeRcfCwumcNdwwQ1LqDqadFIGiunUHUqSn9PYirMUKlzSP4Bo6llTeGJcwLq65SveiC0tt2fzomYLJ2jGYB465rKfy7jx8Rx4vQBcU9a8esnKLiPHM52jsOg' \
  -H 'Content-Type: application/json' \
  -d '{
  "documentId": "381a05a2-14ed-ee11-aaf0-002248996ede",
  "boostExtractionConfidence": 70
}'curl -X 'POST' \
  'https://cloud.uipath.com/<Organization_Name>/<Tenant_Name>/du_/api/framework/projects/<Project_ID>/extractors/invoices/extraction/start?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IkY5QTYwNUMxRDlFOEQyNzFGNTZBOEE4NzI2NTgzMURBRjkyMkQ5ODAiLCJ4NXQiOiItYVlGd2RubzBuSDFhb3FISmxneDJ2a2kyWUEiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3N0YWdpbmcudWlwYXRoLmNvbS9pZGVudGl0eV8iLCJuYmYiOjE3MTE2Mzc3NDQsImlhdCI6MTcxMTYzODA0NCwiZXhwIjoxNzExNjQxNjQ0LCJhdWQiOiJVaVBhdGguRG9jdW1lbnRVbmRlcnN0YW5kaW5nIiwic2NvcGUiOlsiRHUuQ2xhc3NpZmljYXRpb24uQXBpIiwiRHUuRGlnaXRpemF0aW9uLkFwaSIsIkR1LkV4dHJhY3Rpb24uQXBpIiwiRHUuVmFsaWRhdGlvbi5BcGkiXSwic3ViX3R5cGUiOiJzZXJ2aWNlLmV4dGVybmFsIiwicHJ0X2lkIjoiOTViYWY3YTItNTljNC00NDM4LTkzYmItNTU5NjdmMTA0OTA0IiwiY2xpZW50X2lkIjoiNzI4MWU5OTgtZjczMC00MDVmLThmNTQtMzQ1NWQyMzJmZjA0IiwianRpIjoiOUQ0ODhBMDczQkEyNjVEQTNCNjNCMTU0OTdGQkQ0M0IifQ.ij6SIKi1aT3TrsSP3JVzOomhyESKVgSd4KQlU_PyRBI3gaLbtS3CIM0tmIuaXpKhwrIpTjPbXRLzF0nzu7u7YX7ICTmMO3hL_Ym3EXB9rGDJSlHyiunwEq-6RMyOq3I7naKEQv5ZOHK9lksgH3OWRN8CmsBynuJR59WBjDbkd8tVwiHdkfYS4EJ2FsDM6f4otIpJ4DJ0xqf95eVF7b4H1VciSNJ2pYeeRcfCwumcNdwwQ1LqDqadFIGiunUHUqSn9PYirMUKlzSP4Bo6llTeGJcwLq65SveiC0tt2fzomYLJ2jGYB465rKfy7jx8Rx4vQBcU9a8esnKLiPHM52jsOg' \
  -H 'Content-Type: application/json' \
  -d '{
  "documentId": "381a05a2-14ed-ee11-aaf0-002248996ede",
  "boostExtractionConfidence": 70
}'
Note: The boostExtractionConfidence parameter is used to boost the extraction confidence when extracting Document Data with APIs. Only field values with confidence below this threshold will be verified against the generative model, and if the values match, their confidence score is boosted.
Important:

This feature is currently part of an audit process and is not to be considered part of the FedRAMP Authorization until the review is finalized. See here the full list of features currently under review.

Response of extracting fields from a document

{ "operationId": "eee0a911-dfe8-ed11-907c-6045bd9d17d0" }{ "operationId": "eee0a911-dfe8-ed11-907c-6045bd9d17d0" }

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.