Named entities

curl -X POST "$DOATHING_API/v1/nlp/named-entities" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "Ada Lovelace worked in London for Charles Babbage. She wrote the first algorithm intended for a machine. Her notes described a general-purpose computer a century before one was built."}'

People, places and organisations pulled out and labelled.

Extract person, organisation, location and GPE entities using NLTK chunking.

Input

Send either a text string or a file object. A file is decoded as UTF-8 and must be one of text/plain, text/markdown, text/html, text/csv.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "entities": [
    {
      "text": "Ada Lovelace",
      "label": "PERSON",
      "description": "a person",
      "mentions": 1
    }
  ],
  "count": 3,
  "mentions": 3,
  "counts": {
    "PERSON": 2,
    "GPE": 1
  },
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

3 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.