> ## 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.

# Research Status

> Poll an async research request by request_id.



## 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: Contact APIs
    description: >-
      Search people and enrich work email, phone, and reverse-email contact
      fields.
  - name: Company APIs
    description: >-
      Search companies and retrieve company-level attributes such as detected
      technology stack and active job postings.
  - name: Research APIs
    description: >-
      Research one company, person, team, or focused business question and
      return a sales-ready answer. Lite, standard, and deep tiers.
  - name: LinkedIn APIs
    description: >-
      LinkedIn URL discovery, company and profile pages, posts, reactions, and
      comments.
  - name: X APIs
    description: X profiles, posts, search results, and thread context.
  - name: Web APIs
    description: >-
      Find, scrape, 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 APIs
      summary: Research Status
      description: Poll an async research request by request_id.
      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
                required:
                  - status
                  - request_id
                  - key_id
                  - tier
                  - model
                  - created_at
                properties:
                  status:
                    type: string
                    enum:
                      - running
                      - completed
                      - failed
                  request_id:
                    type: string
                  key_id:
                    type: string
                  tier:
                    type: string
                    enum:
                      - lite
                      - standard
                      - deep
                  model:
                    type: string
                  created_at:
                    type: string
                  completed_at:
                    type: string
                  result:
                    nullable: true
                    oneOf:
                      - title: Text answer
                        description: Plain-text or markdown research output.
                        type: string
                      - title: Structured object
                        description: >-
                          Object output when the request asks for structured
                          fields.
                        type: object
                        additionalProperties: true
                      - title: Structured array
                        description: >-
                          Array output when the request asks for a list-shaped
                          result.
                        type: array
                        items: {}
                  data_source:
                    type: string
                  confidence:
                    type: object
                    nullable: true
                    additionalProperties:
                      type: string
                  price:
                    type: number
                  error:
                    type: string
                  error_code:
                    type: string
                  error_details:
                    type: object
                    additionalProperties: true
                additionalProperties: false
              examples:
                running:
                  summary: Running
                  value:
                    status: running
                    request_id: req_1746123456_ef1z5p
                    key_id: key_123
                    tier: deep
                    model: gemini-2.5-flash
                    created_at: '2026-07-21T12:00:00.000Z'
                completed:
                  summary: Completed free-text result
                  value:
                    status: completed
                    request_id: req_1746123456_ef1z5p
                    key_id: key_123
                    tier: deep
                    model: gemini-2.5-flash
                    created_at: '2026-07-21T12:00:00.000Z'
                    completed_at: '2026-07-21T12:01:30.000Z'
                    result: Research answer...
                    confidence:
                      level: medium
                      reason: >-
                        Based on current public sources found during the
                        request.
                    data_source: live
                    price: 0.046
                completedSchema:
                  summary: Completed structured result
                  value:
                    status: completed
                    request_id: req_1746123456_ef1z5p
                    key_id: key_123
                    tier: deep
                    model: gemini-2.5-flash
                    created_at: '2026-07-21T12:00:00.000Z'
                    completed_at: '2026-07-21T12:01:30.000Z'
                    result:
                      summary: Stripe is expanding enterprise payment infrastructure.
                      recommended_angles:
                        - Fraud prevention for high-risk payment flows
                      risks:
                        - Existing in-house risk tooling
                    confidence:
                      level: medium
                      reason: >-
                        Based on current public sources found during the
                        request.
                    price: 0.046
                failed:
                  summary: Failed
                  value:
                    status: failed
                    request_id: req_1746123456_ef1z5p
                    key_id: key_123
                    tier: deep
                    model: gemini-2.5-flash
                    created_at: '2026-07-21T12:00:00.000Z'
                    completed_at: '2026-07-21T12:01:30.000Z'
                    result: null
                    confidence: null
                    data_source: live
                    error: Research failed
                    error_code: AGENT_FAILURE
                    error_details: {}
                    price: 0
        '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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.