Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.thehog.ai/llms.txt

Use this file to discover all available pages before exploring further.

The research endpoint builds a comprehensive dossier for each contact you submit by resolving their identity across multiple platforms and aggregating publicly available profile data into a single structured result. You can submit contacts by their person ID (as returned from people search) or by passing platform handles directly — The Hog resolves the identity automatically. Because this endpoint performs live cross-platform lookups, responses are synchronous but may take between 2 and 30 seconds depending on the number of contacts and platforms involved. For large batches, call the estimate endpoint first to confirm credit cost and expected latency.

​
Request

POST https://api.thehog.ai/api/people/researches

​
Authentication

HeaderRequiredDescription
AuthorizationYesBearer <your-api-key>
X-Project-IdNoOptional project context.

​
Body Parameters

​
people
ResearchTarget[]
List of contacts to research, identified by their The Hog person ID. Use this when you already have IDs from a prior people search call.
​
identities
PlatformIdentity[]
List of platform handles for contacts you want to research without a prior person ID lookup. The Hog resolves each handle to a person record before building the dossier.
​
projectId
string
Project context override. Overrides the X-Project-Id header when set.
You must provide at least one of people or identities. Both can be included in the same request.

​
Response

The response is synchronous with a 200 status code. Expect a latency of 2–30 seconds.
​
data
ResearchResult[]
One result object per contact researched.
​
meta
object
Request metadata and cost information.
Before running a large research batch, use POST /api/people/researches/estimate to get a pre-flight credit and latency estimate at no charge.

​
Examples

curl -X POST https://api.thehog.ai/api/people/researches \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "people": [
      { "personId": "per_01hx9k2m3n4p5q6r7s8t" },
      { "personId": "per_01hx9k2m3n4p5q6r7s8u" }
    ]
  }'