For AI agents: llms.txt.

People search

Request example

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

Authorization

Authorizationheaderrequired

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

Body parameters

querystringrequired

The name, phone number, email address, or username to look up.

typeenum

How to interpret the query.

namephoneemailusername

Default: name

platformsstring | string[]

For a username search, narrow discovery to supported focus platforms (e.g. instagram, x, linkedin). Ignored for other types.

formatenum

sse streams Server-Sent Events as results arrive; json collects every event and returns one object.

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

Submit an identifier and stream back ranked candidate matches (PersonHit objects) drawn from public sources. Each candidate carries a confidence score and descriptive tags so you can disambiguate before requesting a full dossier.

Usage & caching

Standard search is Medium usage. Cached results and idempotent replays use no usage.

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

Skip to content