For AI agents: llms.txt.

Person dossier

Request example

POST/api/v1/dossier
Scope
dossier
Formats
JSON · SSE
Sandbox
Free fixtures

Authorization

Authorizationheaderrequired

Send Bearer $DEEPSEARCH_API_KEY with the dossier scope. The free sandbox uses the published test key.

Body parameters

personobjectrequired

The subject to profile. Only person.name is required; pass the full PersonHit from /search to focus on the exact candidate.

person.namestringrequired

The person's full name.

refreshboolean

Skip this account's cached report and rebuild from scratch (this always meters).

Default: false

formatenum

sse to stream sections as they fill, or json for a single collected response.

ssejson

Default: sse

sandboxboolean

Return deterministic, unmetered fixtures for CI, demos, and parser development.

Default: false

Response

JSON responses preserve the operation result and include request metadata, usage, and collected events. SSE delivers progress and result events as they arrive.

Sources & coverage

Pass a candidate from /search (or a minimal person object) and stream a structured dossier - identity, contact, social accounts, locations, work, mentions and a written summary with cited sources. Reports are cached privately for each account: repeating the same request from the same account replays the cached report instantly and consumes no usage. Reports are not shared between accounts.

Usage & caching

A fresh dossier is High usage and covers all nested work. Cached dossiers use no usage.

Examples illustrate the contract. Test request runs the selected deployment; sandbox fixtures are unmetered.

Skip to content