Sign in
Enhance

Enhance

Enrich a person or organization record with partial data input (POST option)

post/kg/v3/enhance

Request body

type'Person' | 'Organization' enum

Diffbot entity type

idstring

DiffbotId of entity to enhance. Parameter can be used with types Person and Organization

locationstring

Location of the entity to enhance. Parameter can be used with types Person and Organization

ipstring

IP address of the entity to enhance. Parameter can be used with types Person and Organization

phonestring

Phone of the entity to enhance. Parameter can be used with types Person and Organization

descriptionstring

Description of the entity to enhance. Parameter can be used with types Person and Organization

employerstring

Employer of the entity to enhance. Parameter can be used only with type Person

titlestring

Title of the entity to enhance. Parameter can be used only with type Person

schoolstring

School of the entity to enhance. Parameter can be used only with type Person

customIdstring

User defined ID for correlation

sizeinteger

Maximum number of results to return

thresholdnumber double

Enhance similarity threshold

refreshboolean

refresh=true indicates that Diffbot will attempt to recrawl all the origins of the identified entity and reconstruct the returned entity from this refreshed data.

searchboolean

search=true indicates that Diffbot will attempt to search the web for origins for the search query and merge relevant results with whats found in the KG.

nonCanonicalFactsboolean

nonCanonicalFacts=true returns non-canonical facts.

jsonmode' ' | 'extended'

jsonmode=extended returns origin information for facts.

filterstring

Semi-colon separated path filter to filter response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

filterExcludestring

Semi-colon separated path filter to filter and exclude data from response json. You can use a simple dot notation skills.name or a JsonPath expression such as such as $.name;$.locations.country.name. For more advanced options, see JsonPath Filtering for syntax.

Response

Enhanced entity

versioninteger

Response version

hitsinteger

Number of matches returned

kgversionstring

Version of KG that was queried

errorsstring[]
searchInfoobject

Search info for debug

Example response

{
  "data": [
    {
      "entity": {
        "id": "EYX1i02YVPsuT7fPLUYgRhQ",
        "images": [
          {
            "naturalHeight": 0,
            "width": 0,
            "url": "https://kg.diffbot.com/image/api/get?fetch=yes&url=g%3Cj7P0St%7D9u.LnOv%7BI%7C%40g7.pBYINs%3Ff%7CGZ7jr-tGZhWf%3DK%2FOvy%5Bp%3CSKbs8i%7CEyNzCa%3EYr%3Ef%3CRc%3CLr5gx_hOgiFuER5%3Cb%7C%3E.I%5Do",
            "isCached": true,
            "naturalWidth": 0,
            "primary": true,
            "height": 0
          }
        ],
        "diffbotUri": "http://diffbot.com/entity/EYX1i02YVPsuT7fPLUYgRhQ",
        "name": "Diffbot",
        "origins": [
          "angel.co/diffbot",
          "bloomberg.com/profiles/companies/0506286D:US-diffbot-corp",
          "crunchbase.com/organization/diffbot",
          "linkedin.com/company/diffbot",
          "en.wikipedia.org/wiki/Diffbot"
        ]
      }
    }
  ]
}

Changes