Use the Discovery APIs

Make a GET request to the project route (no ID is required) using the Discovery Service for retrieving information about the newly created project. The URL needs the org/tenant and the /du_/dpi/framework/projects path. Once you receive the response, every other call that follows requires a some information (projectID, classifierID, extractionID, etc) that are available in the responses of the Discovery calls.

Get the project information

Retrieves all available projects from Document Understanding^TM.

curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs***Q'curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs***Q'

Response of retrieving the project information

Provides details about the used predefined project.

{
  "projects": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Predefined",
      "description": "Predefined models to be used for standard scenarios. For custom extractors, create a Project in the Document Understanding app in Automation Cloud",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1.0",
      "createdOn": "2023-05-01T19:10:04.8751081Z"
    },
    {
      "id": "0884c3e4-5064-ed11-ac20-cc60c8b14803",
      "name": "DU Bootcamp",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/classifiers?api-version=1.0",
      "createdOn": "2022-11-14T19:16:52.6658079Z"
    },
    {
      "id": "15895968-855e-ed11-ade6-cc60c85b4740",
      "name": "Documentation",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/classifiers?api-version=1.0",
      "createdOn": "2022-11-07T10:17:40.2729322Z"
    },
    {
      "id": "64b8c43f-2046-ec11-981f-0050f281975f",
      "name": "ACORD",
      "description": "",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/classifiers?api-version=1.0",
      "createdOn": "2021-11-15T14:28:07.4366667Z"
    },
    
  ]
}{
  "projects": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Predefined",
      "description": "Predefined models to be used for standard scenarios. For custom extractors, create a Project in the Document Understanding app in Automation Cloud",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1.0",
      "createdOn": "2023-05-01T19:10:04.8751081Z"
    },
    {
      "id": "0884c3e4-5064-ed11-ac20-cc60c8b14803",
      "name": "DU Bootcamp",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/0884c3e4-5064-ed11-ac20-cc60c8b14803/classifiers?api-version=1.0",
      "createdOn": "2022-11-14T19:16:52.6658079Z"
    },
    {
      "id": "15895968-855e-ed11-ade6-cc60c85b4740",
      "name": "Documentation",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/15895968-855e-ed11-ade6-cc60c85b4740/classifiers?api-version=1.0",
      "createdOn": "2022-11-07T10:17:40.2729322Z"
    },
    {
      "id": "64b8c43f-2046-ec11-981f-0050f281975f",
      "name": "ACORD",
      "description": "",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f?api-version=1.0",
      "digitizationStartUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/digitization/start?api-version=1.0",
      "extractorsDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/extractors?api-version=1.0",
      "classifiersDiscoveryUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/64b8c43f-2046-ec11-981f-0050f281975f/classifiers?api-version=1.0",
      "createdOn": "2021-11-15T14:28:07.4366667Z"
    },
    
  ]
}

Start retrieving extractors information

Retrieve all extractors from a project.

curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer e***ik5-CinKm6A'curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer e***ik5-CinKm6A'

Response of retrieving extractors information

Provides information about the extractors available for the mentioned project.

This example was trimmed down, for readability purposes.

{
  "extractors": [
    {
      "id": "invoices",
      "name": "Invoices",
      "documentTypeId": "invoices",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction/start?api-version=1.0"
    },
    {
      "id": "acord140",
      "name": "ACORD 140",
      "documentTypeId": "acord140",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction/start?api-version=1.0"
    },
    {
      "id": "vehicle_titles",
      "name": "Vehicle Titles",
      "documentTypeId": "vehicle_titles",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction/start?api-version=1.0"
    }
  ]
}{
  "extractors": [
    {
      "id": "invoices",
      "name": "Invoices",
      "documentTypeId": "invoices",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/invoices/extraction/start?api-version=1.0"
    },
    {
      "id": "acord140",
      "name": "ACORD 140",
      "documentTypeId": "acord140",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/acord140/extraction/start?api-version=1.0"
    },
    {
      "id": "vehicle_titles",
      "name": "Vehicle Titles",
      "documentTypeId": "vehicle_titles",
      "status": "Available",
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/extractors/vehicle_titles/extraction/start?api-version=1.0"
    }
  ]
}

Get classifiers information

Retrieve all classifiers from a project.

curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbG***UZik5-CinKm6A'curl -X 'GET' \
  'https://{fqdn}/uipathstgss/UiPathDefault/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers?api-version=1' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJhbG***UZik5-CinKm6A'

Response of getting the classifiers information

Provides information about the classifiers available for the mentioned project.

{
  "classifiers": [
    {
      "id": "ml-classification",
      "name": "ML Classification (Preview)",
      "status": "Available",
      "documentTypeIds": [
        "1040",
        "4506t",
        "990",
        "acord125",
        "acord126",
        "acord131",
        "acord140",
        "acord25",
        "bank_statements",
        "bills_of_lading",
        "checks",
        "financial_statements",
        "fm1003",
        "i9",
        "id_cards",
        "invoices",
        "packing_lists",
        "passports",
        "purchase_orders",
        "receipts",
        "remittance_advices",
        "utility_bills",
        "vehicle_titles",
        "w2",
        "w9"
      ],
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification/start?api-version=1.0"
    }
  ]
}{
  "classifiers": [
    {
      "id": "ml-classification",
      "name": "ML Classification (Preview)",
      "status": "Available",
      "documentTypeIds": [
        "1040",
        "4506t",
        "990",
        "acord125",
        "acord126",
        "acord131",
        "acord140",
        "acord25",
        "bank_statements",
        "bills_of_lading",
        "checks",
        "financial_statements",
        "fm1003",
        "i9",
        "id_cards",
        "invoices",
        "packing_lists",
        "passports",
        "purchase_orders",
        "receipts",
        "remittance_advices",
        "utility_bills",
        "vehicle_titles",
        "w2",
        "w9"
      ],
      "detailsUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification?api-version=1.0",
      "syncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification?api-version=1.0",
      "asyncUrl": "https://{fqdn}:443/95baf7a2-59c4-4438-93bb-55967f104904/cf7ae654-02bd-412b-b0cd-a2738b31a9c3/du_/api/framework/projects/00000000-0000-0000-0000-000000000000/classifiers/ml-classification/classification/start?api-version=1.0"
    }
  ]
}

On this page

Get the project information
Response of retrieving the project information
Start retrieving extractors information
Response of retrieving extractors information
Get classifiers information
Response of getting the classifiers information

Was this page helpful?

PREVIOUSCreate a new project and an External Application

NEXTUse the Digitization APIs

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy