> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhuntr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Poll research status

> **Requires `x-api-key` header.**

Rate limit: 5 requests/second per API key.

Check the status of an async or long-running research request. Results are stored for 3 days.



## OpenAPI

````yaml /openapi.json get /research/{requestId}/status
openapi: 3.0.3
info:
  title: Huntr — The GTM Intelligence API
  description: >-
    Give AI agents company, people, contact, and web intelligence through one
    API. Search accounts, build targeted lists, enrich leads, find contacts, and
    uncover buying signals.


    **Authentication:** Authenticated endpoints require an `x-api-key` header
    with your Huntr API key. Get a key by signing up via `POST /keys/create`.
    Public endpoints (pricing, sign-up, health) work without a key.


    **Rate limit:** 5 requests/second per API key on authenticated endpoints.
  version: 2.0.0
servers:
  - url: https://api.tryhuntr.com
security: []
tags:
  - name: Research
    description: >-
      Research one company, person, team, or focused business question and
      return a sales-ready answer. Lite, standard, and deep tiers.
  - name: Companies
    description: >-
      Search companies and enrich firmographics. Per-result pricing on search;
      count endpoints are free.
  - name: People
    description: >-
      Search people and enrich contacts — work email, phone, and related lookup
      endpoints.
  - name: LinkedIn
    description: >-
      LinkedIn URL discovery, company and profile pages, posts, reactions, and
      comments.
  - name: X
    description: X profiles, posts, search results, and thread context.
  - name: Web
    description: >-
      Find and analyze pages on a domain, plus tech stack, domain contacts, and
      job postings.
  - name: Account
    description: >-
      Sign up, verify email, recover keys, check balance, view usage, add
      credits, and read the public pricing matrix.
  - name: System
    description: Health check.
paths:
  /research/{requestId}/status:
    get:
      tags:
        - Research
      summary: Poll research status
      description: >-
        **Requires `x-api-key` header.**


        Rate limit: 5 requests/second per API key.


        Check the status of an async or long-running research request. Results
        are stored for 3 days.
      parameters:
        - name: requestId
          in: path
          required: true
          schema:
            type: string
          description: The request_id returned from POST /research.
      responses:
        '200':
          description: >-
            Current state of the request. Poll until status is 'completed' or
            'failed'. Results are stored for 3 days.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - running
                      - completed
                      - failed
                    description: >-
                      '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.
                  request_id:
                    type: string
                    description: >-
                      The request ID, same as what was returned from POST
                      /research.
                  tier:
                    type: string
                    enum:
                      - lite
                      - standard
                      - deep
                    description: Tier this request ran at.
                  model:
                    type: string
                    description: Synthesis model used for this request.
                  created_at:
                    type: string
                    format: date-time
                    description: ISO 8601 timestamp of when the request was accepted.
                  completed_at:
                    type: string
                    format: date-time
                    description: >-
                      ISO 8601 timestamp of when the request finished. Only
                      present on 'completed' or 'failed' status.
                  result:
                    description: >-
                      The research result. String for free-text requests, object
                      for schema requests. Only present when status is
                      'completed'.
                  data_source:
                    type: string
                    enum:
                      - live
                      - mixed
                      - model
                    description: >-
                      Free-text responses only. Same semantics as POST
                      /research.
                  confidence:
                    type: object
                    description: >-
                      Structured responses only. Same semantics as POST
                      /research.
                    additionalProperties:
                      type: string
                      enum:
                        - live
                        - model
                        - not_found
                  price:
                    type: number
                    description: >-
                      Amount charged in USD. 0 if status is 'failed' (no charge
                      on failure).
                  error:
                    type: string
                    description: Error description. Only present when status is 'failed'.
                  error_code:
                    type: string
                    description: >-
                      Machine-readable failure code when available, including
                      BULK_ENRICHMENT_REQUIRED.
                  error_details:
                    type: object
                    description: Structured failure guidance when available.
              examples:
                running:
                  summary: Still running
                  value:
                    status: running
                    request_id: req_1746123456_ef1z5p
                    tier: deep
                    model: gemini-3-flash
                    created_at: '2026-05-03T12:00:00Z'
                completed:
                  summary: Completed — free text
                  value:
                    status: completed
                    request_id: req_1746123456_ef1z5p
                    tier: deep
                    model: gemini-3-flash
                    created_at: '2026-05-03T12:00:00Z'
                    completed_at: '2026-05-03T12:00:45Z'
                    result: Shell's current cloud-efficiency priorities include...
                    data_source: live
                    price: 0.046
                completedSchema:
                  summary: Completed — structured
                  value:
                    status: completed
                    request_id: req_1746123456_cd7y2m
                    tier: deep
                    model: gemini-3-flash
                    created_at: '2026-05-03T12:00:00Z'
                    completed_at: '2026-05-03T12:00:50Z'
                    result:
                      summary: Stripe enterprise account summary...
                      recommended_angles:
                        - Platform fraud prevention
                      risks:
                        - Incumbent internal tooling
                    confidence:
                      summary: live
                      recommended_angles: live
                      risks: live
                    price: 0.046
                failed:
                  summary: Failed — no charge
                  value:
                    status: failed
                    request_id: req_1746123456_gh8w3r
                    tier: deep
                    model: gemini-3-flash
                    created_at: '2026-05-03T12:00:00Z'
                    completed_at: '2026-05-03T12:00:10Z'
                    price: 0
                    error: >-
                      This request requires dedicated list-building and
                      enrichment endpoints.
                    error_code: BULK_ENRICHMENT_REQUIRED
                    error_details:
                      recommended_workflow:
                        - endpoint: /company-search
                          purpose: Build a company list
        '401':
          description: Invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            Request ID not found or result expired (stored for 3 days). Also
            returned if the request_id belongs to a different API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Huntr API key. Get one at tryhuntr.com. Pass as x-api-key header on
        all authenticated requests.

````