Skip to main content
POST

Authorizations

x-api-key
string
header
required

Your Huntr API key. Get one at tryhuntr.com. Pass as x-api-key header on all authenticated requests.

Body

application/json
prompt
string
required

The research question or task. Be specific about the context and output your workflow needs.

tier
enum<string>
default:standard

Controls which capabilities are available and the synthesis model. lite ($0.018) = search + scraping. standard ($0.027) = + extraction + company enrichment. deep ($0.046) = + people enrichment, email finder, LinkedIn.

Available options:
lite,
standard,
deep
model
string

Override the synthesis model. Must match the provider's model ID (e.g. gpt-5, claude-opus-4.7, gemini-3.1-pro). Price adjusts automatically based on model cost.

schema
object

Optional flat field map for structured output. Keys are top-level result fields and values describe what each field should contain. This is not JSON Schema and does not support nested schema definitions. Example: { summary: 'Concise account summary', recommended_angles: 'Array of practical sales angles', risks: 'Array of deal risks' }.

callback_url
string<uri>

Async mode. If provided, the API returns 202 immediately with a request_id and POSTs the full result to this URL when done. Useful for long-running deep research.

Response

Research completed synchronously.

success
boolean

Always true on 200.

request_id
string

Unique request identifier for logs and support. Status polling is available for async requests accepted with callback_url.

result
any

The research answer. String when no schema was provided. Object matching your schema keys when schema was provided — null fields mean not found.

data_source
enum<string>

Present on free-text responses. 'live' means the answer was grounded in current retrieved data; 'mixed' means current data plus stable model knowledge; 'model' means retrieval returned no usable data and the answer relies on model knowledge.

Available options:
live,
mixed,
model
confidence
object

Present on structured responses. Per-field source label: 'live', 'model', or 'not_found'. A not-found field is returned as null.

tier
enum<string>

Tier used for this request, as resolved from the request body.

Available options:
lite,
standard,
deep
model
string

Synthesis model actually used (default for tier or your override).

price
number

Amount charged in USD for this request. Deducted from your balance.

credits_remaining
number

Your balance in USD after this request was charged.