What is a URL Field?

The URL field data type enables users to extract url address from their documents using the API Builder. This is done by selecting the URL field when creating and defining your data model.

Set Up URL Field

After you've set up your custom API,

  • Go to the define your model page
  • Set up the url field by choosing URL from the right side menu.
    url model field
  • Enter the Field Name and API Response Key according to the data you want to extract.
    url field name and API response filled


The API Response Key is automatically filled for you but you can change that to something most suitable for you according to your needs.

Additional Parameters

If you have additional context about this specific field and how the information is usually displayed in your documents, you can specify it during the field set up by enabling the checkbox that suits your demand.
url field additional parameters

  • Can be handwritten: by checking this, the API will be able to detect handwritten words more accurately. This doesn’t stop the API from detecting non-handwritten words.

Training and Predictions

By specifying the data type as URL, you will enable the API to only consider words and series of words that can be interpreted as URL as eligible candidates.

This means that, the API will not extract any information in your document that cannot be interpreted as URL for this specific field.


Slack Logo Icon  Join our Slack