Poll research status

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.

Path Parameters

requestId

string

required

The request_id returned from POST /research.

Response

Current state of the request. Poll until status is 'completed' or 'failed'. Results are stored for 3 days.

status

enum<string>

'running' = still in progress, check back. 'completed' = result is ready in the result field. 'failed' = agent error, see the error field — you were not charged.

Available options:

running,

completed,

failed

request_id

string

The request ID, same as what was returned from POST /research.

tier

enum<string>

Tier this request ran at.

Available options:

lite,

standard,

deep

model

string

Synthesis model used for this request.

created_at

string<date-time>

ISO 8601 timestamp of when the request was accepted.

completed_at

string<date-time>

ISO 8601 timestamp of when the request finished. Only present on 'completed' or 'failed' status.

result

any

The research result. String for free-text requests, object for schema requests. Only present when status is 'completed'.

data_source

enum<string>

Free-text responses only. Same semantics as POST /research.

Available options:

live,

mixed,

model

confidence

object

Structured responses only. Same semantics as POST /research.

Show child attributes

price

number

Amount charged in USD. 0 if status is 'failed' (no charge on failure).

error

string

Error description. Only present when status is 'failed'.

error_code

string

Machine-readable failure code when available, including BULK_ENRICHMENT_REQUIRED.

error_details

object

Structured failure guidance when available.