unlob Docs
Browse documentation

One-hop brief on an entity — GET /dossier

Coverage Graph: a one-hop brief on an entity — the passages that mention it, its top source hosts, and the entities it co-occurs with.

get /dossier

Request

curl \
  -H "x-api-key: $UNLOB_API_KEY" \
  "https://api.unlob.com/dossier?entity=<entity>"

Behaviour

Replaces roughly ten searches and a manual merge. The co-mentioned entities are the leads: they are what you did not know to search for.

Costs 2 credits; a call that runs and fails costs 1.

Parameters

NameTypeDescription
entityrequiredstringEntity / salient term.
limitintegerMaximum mentions, default 10.

Responses

StatusMeaning
200Mentions, top source hosts, and co-mentioned entities.
401Missing, unknown or revoked key. A key minted moments ago can answer 401 until it propagates to the serving fleet.
429Over the per-minute rate (spent in credits), or a hard-capped key without the credits this call costs. `retry-after` is present on the rate-limit case only.

The same call over MCP

This capability is dossier on the MCP server, taking the same parameters and returning the same body. A parity test in the API fails the build if the two ever diverge, so you can read either reference and use the other.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dossier",
    "arguments": {
      "entity": "<entity>"
    }
  }
}

Most clients build that frame for you — see Connect a client.

See Errors for what to do with each status, and Retries and backoff for which are worth repeating.

FAQ

What does 200 mean on GET /dossier?
Mentions, top source hosts, and co-mentioned entities.
What does 401 mean on GET /dossier?
Missing, unknown or revoked key. A key minted moments ago can answer 401 until it propagates to the serving fleet.
What does 429 mean on GET /dossier?
Over the per-minute rate (spent in credits), or a hard-capped key without the credits this call costs. `retry-after` is present on the rate-limit case only.