entities

Free text → refs with confidence (the front door)

The ONE endpoint that accepts free text. Returns candidates ordered best-first; best is null when nothing clears the confidence floor — the API never guesses for you.

get/v2/entities/resolve

Request

  • Base URL: https://api.cardog.app
  • URL: https://api.cardog.app/v2/entities/resolve
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

qstring required

"2021 Civic", "teslla", …

domainstring

Constrain to one domain (optional)

limitinteger

Max candidates

Response

Candidates with confidence

querystring required
domainstring nullable

Entity domain, e.g. "make", "model", "model-year", "fuel-type"

linksobject

Related resources, keyed by relation name, each a server-relative path. Example: {"recalls": "/v2/recalls/entity/model-year:toyota/rav4/2021"}

Changes

No recorded changes to this operation across all 1 revision of this API.