Quickstart

Access Key

Your API Access Key is your unique authentication key. You will need it to make requests. Append the access_key parameter to the API's base URL and set it to your access key value. Here is an example:

https://um-public.nlp.vicomtech.org?access_key=YOUR-ACCESS-KEY
Register to get an access key
Step 1: POST a document

Starts by POSTing the text you want to analyze with UMLSmapper. Just make a POST call to the base URL with the access_key set to your access key value. The body of the call should be a JSON file that contains your text and the language in which the text is written: Spanish (es) or English (en). For instance: 

curl -X POST \
  -H "Content-type: application/json" \
  -H "Accept: text/plain" \
  -d '{"text": "Sin signos de carcinomatosis", "language": "es"}' \
  "https://um-public.nlp.vicomtech.org?access_key=YOUR-ACCESS-KEY"

The response of this method is the registered document's identifier as plain text, which you will need in the next step.

Step 2: GET mappings

Next, we get the mapping to the UMLS Metathesaurus of the posted document. In the following example, we retrieve the mappings of the document 42:

curl -X GET \
  -H "Accept: application/json" \
  "https://um-public.nlp.vicomtech.org/42?access_key=YOUR-ACCESS-KEY"

The result is delivered in JSON format. Read about it's structure here.

Next steps

UMLSmapper has many settings that can be configured with each request in order to obtain mappings suitable for different domains and tasks. Read about UMLSmapper's settings.

You may delete a POSTed document from your collection. Read about the DELETE method.