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 running a people enrichment request, call this endpoint with the same body you plan to send to POST /api/people/enrich. You get back an estimated credit cost, whether the real request will run synchronously or asynchronously, and whether your current plan balance covers it. No credits are charged for calling this endpoint.

​
Request

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

​
Authentication

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

​
Body Parameters

This endpoint accepts the same body as POST /api/people/enrich.
​
people
PersonIdentifier[]
List of person IDs to estimate enrichment for.
​
identities
PlatformIdentity[]
Platform handles to resolve before enrichment.
​
asyncPreferred
boolean
default:"true"
Controls the likelySyncOrAsync field in the response. Pass the same value you intend to use in the real request.
​
projectId
string
Project context override.
​
maxEmailProviderAttempts
number
default:"2"
Email waterfall depth for the estimate. Range: 1–2.
​
maxPhoneProviderAttempts
number
default:"3"
Phone waterfall depth for the estimate. Range: 1–3.

​
Response

​
data
object
The estimate result.
​
meta
object

​
Example

curl -X POST https://api.thehog.ai/api/people/enrich/estimate \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identities": [
      { "platform": "linkedin", "username": "jordanrivera" },
      { "platform": "linkedin", "username": "samchen-eng" }
    ],
    "asyncPreferred": true,
    "maxEmailProviderAttempts": 2,
    "maxPhoneProviderAttempts": 3
  }'