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.

Before submitting a people research request, use this endpoint to get a pre-flight estimate of the credit cost and expected latency range. Pass the same request body you intend to send to POST /api/people/researches. The estimate call is free — no credits are deducted.

​
Request

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

​
Authentication

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

​
Body Parameters

​
people
ResearchTarget[]
List of contacts to estimate research for, by The Hog person ID.
​
identities
PlatformIdentity[]
Platform handles to resolve before research. The estimate accounts for identity resolution as well as dossier building.
​
projectId
string
Project context override.

​
Response

​
data
object
The estimate result.
​
meta
object

​
Example

curl -X POST https://api.thehog.ai/api/people/researches/estimate \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identities": [
      { "platform": "linkedin", "username": "jordanrivera" },
      { "platform": "github", "username": "jrivera-eng" }
    ]
  }'