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

# Get a content gap

> Full detail of a content-gap suggestion: brief, outline, reasoning,
similar competitor topic, closest existing page on the website.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/content-gaps/{suggestion_id}
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: AI citations, prompts, topics,
    competitors, sources, audits, site health, indexation, AI-crawler traffic,
    and outreach. Authenticate with a personal API key sent as `Authorization:
    Bearer <key>`. Create one in the dashboard under **Settings > API keys**.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Account
    description: The user behind the API key.
  - name: Workspaces
    description: >-
      Workspaces the user belongs to. Use them to find the websites you can
      query.
  - name: Websites
    description: Every website the user can access, with its subscription status.
  - name: Website
    description: Metadata and plan of one website.
  - name: Citations
    description: >-
      Every time an AI assistant answers one of your prompts, Hikoo stores the
      answer as a citation. These endpoints list them and aggregate them by
      platform, source, sentiment and match type.
  - name: Prompts
    description: >-
      Prompts are the questions Hikoo sends to AI assistants for a website.
      Create, edit, archive and restore them, and read their visibility, answers
      and citations.
  - name: Topics
    description: Topics group prompts. Every prompt belongs to one topic.
  - name: Search queries
    description: >-
      The web searches AI assistants run internally (query fan-out) before
      answering your prompts.
  - name: URL lookup
    description: >-
      Where one URL shows up, across AI-cited sources and AI-crawler traffic, in
      one call.
  - name: Competitors
    description: >-
      Tracked competitors, their share of voice, and the competitor suggestions
      Hikoo detects in AI answers.
  - name: Source intelligence
    description: >-
      The domains and pages AI assistants cite for your prompts, and who appears
      on them.
  - name: Audits
    description: GEO audits of a full site, a list of pages or a single URL.
  - name: Health
    description: >-
      Site-level checks for AI readiness (robots.txt, llms.txt, sitemap) and
      improvement suggestions.
  - name: Indexation
    description: >-
      The pages Hikoo crawled on your website, their category, health and
      errors.
  - name: Content gaps
    description: >-
      Topics where AI assistants answer without citing you, with a content brief
      for each.
  - name: Agent analytics
    description: Traffic from AI crawlers and AI agents on your website.
  - name: Outreach
    description: >-
      The outreach agent: sources worth getting cited on, their contacts, the
      pitches waiting for approval, follow-ups, and what the agent is allowed to
      do on its own.
paths:
  /api/v1/public/content-gaps/{suggestion_id}:
    get:
      tags:
        - Content gaps
      summary: Get a content gap
      description: |-
        Full detail of a content-gap suggestion: brief, outline, reasoning,
        similar competitor topic, closest existing page on the website.
      operationId: get_content_gap_api_v1_public_content_gaps__suggestion_id__get
      parameters:
        - name: suggestion_id
          in: path
          required: true
          schema:
            type: integer
            title: Suggestion Id
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentGapSuggestionSchema'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    ContentGapSuggestionSchema:
      properties:
        id:
          type: integer
          title: Id
        client_site_id:
          type: integer
          title: Client Site Id
        suggested_topic:
          type: string
          title: Suggested Topic
        reasoning:
          anyOf:
            - type: string
            - type: 'null'
          title: Reasoning
        content_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Type
        content_brief:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Brief
        priority:
          $ref: '#/components/schemas/SuggestionPriority'
          default: medium
        source_kind:
          anyOf:
            - $ref: '#/components/schemas/ContentSuggestionSourceKind'
            - type: 'null'
        primary_query:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Query
        content_job:
          anyOf:
            - $ref: '#/components/schemas/ContentSuggestionJob'
            - type: 'null'
        generation_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Generation Version
        brief:
          anyOf:
            - $ref: '#/components/schemas/ContentSuggestionBriefV1'
            - type: 'null'
        evidence:
          anyOf:
            - $ref: '#/components/schemas/ContentSuggestionEvidenceV1'
            - type: 'null'
        similarity_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Similarity Score
        above_threshold:
          type: boolean
          title: Above Threshold
          default: false
        similarity_threshold:
          anyOf:
            - type: number
            - type: 'null'
          title: Similarity Threshold
        status:
          $ref: '#/components/schemas/ContentGapStatus'
        closest_page:
          anyOf:
            - $ref: '#/components/schemas/ClosestPageSchema'
            - type: 'null'
        competitor_topic:
          anyOf:
            - type: string
            - type: 'null'
          title: Competitor Topic
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - client_site_id
        - suggested_topic
        - reasoning
        - similarity_score
        - status
        - closest_page
        - competitor_topic
        - created_at
      title: ContentGapSuggestionSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SuggestionPriority:
      type: string
      enum:
        - high
        - medium
        - low
      title: SuggestionPriority
    ContentSuggestionSourceKind:
      type: string
      enum:
        - fanout
        - editorial
        - citation_gap
        - google_trends
        - blended
        - gsc
      title: ContentSuggestionSourceKind
    ContentSuggestionJob:
      type: string
      enum:
        - direct_answer
        - comparison
        - decision_support
        - use_case
        - proof
        - entity_explainer
        - research_synthesis
      title: ContentSuggestionJob
    ContentSuggestionBriefV1:
      properties:
        version:
          type: integer
          maximum: 1
          minimum: 1
          title: Version
          default: 1
        primary_query:
          type: string
          maxLength: 300
          minLength: 3
          title: Primary Query
        canonical_intent:
          type: string
          maxLength: 600
          minLength: 10
          title: Canonical Intent
        search_intent:
          $ref: '#/components/schemas/SearchIntent'
        content_job:
          $ref: '#/components/schemas/ContentSuggestionJob'
        asset_decision:
          $ref: '#/components/schemas/ContentAssetDecision'
        buyer_stage:
          $ref: '#/components/schemas/ContentBuyerStage'
        audience:
          type: string
          maxLength: 400
          minLength: 3
          title: Audience
        job_to_be_done:
          type: string
          maxLength: 600
          minLength: 10
          title: Job To Be Done
        recommended_format:
          $ref: '#/components/schemas/ContentRecommendedFormat'
        angle:
          type: string
          maxLength: 600
          minLength: 10
          title: Angle
        why_now:
          type: string
          maxLength: 800
          minLength: 10
          title: Why Now
        reader_outcome:
          type: string
          maxLength: 600
          minLength: 10
          title: Reader Outcome
        existing_coverage_summary:
          type: string
          maxLength: 1200
          minLength: 10
          title: Existing Coverage Summary
        information_gain:
          type: string
          maxLength: 1200
          minLength: 10
          title: Information Gain
        why_new_page:
          type: string
          maxLength: 1000
          minLength: 10
          title: Why New Page
        outline:
          items:
            $ref: '#/components/schemas/ContentSuggestionOutlineSection'
          type: array
          maxItems: 8
          minItems: 4
          title: Outline
        secondary_questions:
          items:
            type: string
          type: array
          maxItems: 8
          title: Secondary Questions
        proof_plan:
          items:
            $ref: '#/components/schemas/ContentSuggestionProofRequirement'
          type: array
          maxItems: 6
          minItems: 2
          title: Proof Plan
        original_value_requirements:
          items:
            type: string
          type: array
          maxItems: 8
          minItems: 1
          title: Original Value Requirements
        citable_blocks:
          items:
            $ref: '#/components/schemas/ContentSuggestionCitableBlock'
          type: array
          maxItems: 5
          minItems: 1
          title: Citable Blocks
        internal_links:
          items:
            $ref: '#/components/schemas/ContentSuggestionInternalLink'
          type: array
          maxItems: 6
          title: Internal Links
        overlap_notes:
          type: string
          maxLength: 800
          minLength: 3
          title: Overlap Notes
        geo_requirements:
          items:
            type: string
          type: array
          maxItems: 8
          minItems: 1
          title: Geo Requirements
      additionalProperties: false
      type: object
      required:
        - primary_query
        - canonical_intent
        - search_intent
        - content_job
        - asset_decision
        - buyer_stage
        - audience
        - job_to_be_done
        - recommended_format
        - angle
        - why_now
        - reader_outcome
        - existing_coverage_summary
        - information_gain
        - why_new_page
        - outline
        - proof_plan
        - original_value_requirements
        - citable_blocks
        - overlap_notes
        - geo_requirements
      title: ContentSuggestionBriefV1
    ContentSuggestionEvidenceV1:
      properties:
        version:
          type: integer
          maximum: 1
          minimum: 1
          title: Version
          default: 1
        primary_source_kind:
          $ref: '#/components/schemas/ContentSuggestionSourceKind'
        signals:
          items:
            $ref: '#/components/schemas/ContentSuggestionSignal'
          type: array
          maxItems: 20
          minItems: 1
          title: Signals
        proof_readiness:
          $ref: '#/components/schemas/ContentSuggestionProofReadiness'
        sources:
          items:
            $ref: '#/components/schemas/ContentSuggestionEvidenceSource'
          type: array
          maxItems: 10
          title: Sources
        related_existing_pages:
          items:
            $ref: '#/components/schemas/RelatedExistingPage'
          type: array
          maxItems: 5
          title: Related Existing Pages
        provenance:
          $ref: '#/components/schemas/ContentSuggestionProvenance'
      additionalProperties: false
      type: object
      required:
        - primary_source_kind
        - signals
        - proof_readiness
        - provenance
      title: ContentSuggestionEvidenceV1
    ContentGapStatus:
      type: string
      enum:
        - NEW
        - REVIEWED
        - ACCEPTED
        - DISMISSED
        - WRITTEN
      title: ContentGapStatus
    ClosestPageSchema:
      properties:
        id:
          type: integer
          title: Id
        url:
          type: string
          title: Url
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
      type: object
      required:
        - id
        - url
        - title
      title: ClosestPageSchema
    Error:
      type: object
      title: Error
      required:
        - detail
      properties:
        detail:
          type: string
          description: Human-readable explanation of the error.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SearchIntent:
      type: string
      enum:
        - informational
        - commercial_investigation
        - transactional
        - navigational
      title: SearchIntent
    ContentAssetDecision:
      type: string
      enum:
        - new_page
        - update_existing
        - reject
      title: ContentAssetDecision
    ContentBuyerStage:
      type: string
      enum:
        - unaware
        - problem_aware
        - solution_aware
        - product_aware
        - most_aware
      title: ContentBuyerStage
    ContentRecommendedFormat:
      type: string
      enum:
        - article
        - guide
        - comparison
        - tutorial
        - checklist
        - faq
        - landing_page
        - research_report
      title: ContentRecommendedFormat
    ContentSuggestionOutlineSection:
      properties:
        heading:
          type: string
          maxLength: 180
          minLength: 3
          title: Heading
        objective:
          type: string
          maxLength: 600
          minLength: 10
          title: Objective
        questions:
          items:
            type: string
          type: array
          maxItems: 4
          minItems: 1
          title: Questions
      additionalProperties: false
      type: object
      required:
        - heading
        - objective
        - questions
      title: ContentSuggestionOutlineSection
    ContentSuggestionProofRequirement:
      properties:
        proof_id:
          type: string
          maxLength: 80
          pattern: ^proof_[a-zA-Z0-9_-]+$
          title: Proof Id
        claim_or_question:
          type: string
          maxLength: 800
          minLength: 10
          title: Claim Or Question
        required_evidence:
          type: string
          maxLength: 800
          minLength: 10
          title: Required Evidence
        preferred_source_type:
          $ref: '#/components/schemas/EvidenceSourceType'
        availability:
          $ref: '#/components/schemas/ProofAvailability'
        source_ids:
          items:
            type: string
          type: array
          maxItems: 8
          title: Source Ids
        claim_boundary:
          type: string
          maxLength: 800
          minLength: 10
          title: Claim Boundary
      additionalProperties: false
      type: object
      required:
        - proof_id
        - claim_or_question
        - required_evidence
        - preferred_source_type
        - availability
        - claim_boundary
      title: ContentSuggestionProofRequirement
    ContentSuggestionCitableBlock:
      properties:
        block_type:
          type: string
          maxLength: 80
          minLength: 3
          title: Block Type
        purpose:
          type: string
          maxLength: 500
          minLength: 10
          title: Purpose
      additionalProperties: false
      type: object
      required:
        - block_type
        - purpose
      title: ContentSuggestionCitableBlock
    ContentSuggestionInternalLink:
      properties:
        page_id:
          type: integer
          title: Page Id
        url:
          type: string
          title: Url
        title:
          anyOf:
            - type: string
              maxLength: 300
              minLength: 1
            - type: 'null'
          title: Title
        reason:
          type: string
          maxLength: 500
          minLength: 5
          title: Reason
      additionalProperties: false
      type: object
      required:
        - page_id
        - url
        - reason
      title: ContentSuggestionInternalLink
    ContentSuggestionSignal:
      properties:
        kind:
          $ref: '#/components/schemas/ContentSuggestionEvidenceKind'
        label:
          type: string
          maxLength: 300
          minLength: 1
          title: Label
        query:
          type: string
          maxLength: 300
          minLength: 1
          title: Query
        seed_query:
          anyOf:
            - type: string
              maxLength: 300
            - type: 'null'
          title: Seed Query
        signal:
          anyOf:
            - $ref: '#/components/schemas/ContentSuggestionSignalClass'
            - type: 'null'
        raw_value:
          anyOf:
            - type: number
            - type: integer
            - type: string
            - type: 'null'
          title: Raw Value
        timeframe:
          anyOf:
            - type: string
              maxLength: 80
            - type: 'null'
          title: Timeframe
        geo:
          anyOf:
            - type: string
              maxLength: 20
            - type: 'null'
          title: Geo
        rank:
          anyOf:
            - type: integer
              maximum: 100
              minimum: 1
            - type: 'null'
          title: Rank
        publisher:
          anyOf:
            - type: string
              maxLength: 300
            - type: 'null'
          title: Publisher
        title:
          anyOf:
            - type: string
              maxLength: 600
            - type: 'null'
          title: Title
        snippet:
          anyOf:
            - type: string
              maxLength: 1200
            - type: 'null'
          title: Snippet
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
        observed_at:
          type: string
          format: date-time
          title: Observed At
      additionalProperties: false
      type: object
      required:
        - kind
        - label
        - query
        - observed_at
      title: ContentSuggestionSignal
    ContentSuggestionProofReadiness:
      properties:
        status:
          $ref: '#/components/schemas/ProofReadinessStatus'
        found_source_count:
          type: integer
          maximum: 20
          minimum: 0
          title: Found Source Count
        brand_contribution_required:
          type: boolean
          title: Brand Contribution Required
        reason:
          type: string
          maxLength: 800
          minLength: 5
          title: Reason
      additionalProperties: false
      type: object
      required:
        - status
        - found_source_count
        - brand_contribution_required
        - reason
      title: ContentSuggestionProofReadiness
    ContentSuggestionEvidenceSource:
      properties:
        source_id:
          type: string
          maxLength: 80
          pattern: ^source_[a-zA-Z0-9_-]+$
          title: Source Id
        title:
          type: string
          maxLength: 600
          minLength: 1
          title: Title
        publisher:
          type: string
          maxLength: 300
          minLength: 1
          title: Publisher
        source_type:
          $ref: '#/components/schemas/EvidenceSourceType'
        verification_status:
          $ref: '#/components/schemas/SourceVerificationStatus'
        source_url:
          type: string
          title: Source Url
        published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Published At
        observed_at:
          type: string
          format: date-time
          title: Observed At
        supports_proof_ids:
          items:
            type: string
          type: array
          maxItems: 6
          title: Supports Proof Ids
        relevance_note:
          type: string
          maxLength: 800
          minLength: 5
          title: Relevance Note
      additionalProperties: false
      type: object
      required:
        - source_id
        - title
        - publisher
        - source_type
        - verification_status
        - source_url
        - observed_at
        - relevance_note
      title: ContentSuggestionEvidenceSource
    RelatedExistingPage:
      properties:
        page_id:
          type: integer
          title: Page Id
        url:
          type: string
          title: Url
        title:
          anyOf:
            - type: string
              maxLength: 600
            - type: 'null'
          title: Title
        relationship:
          $ref: '#/components/schemas/ContentCoverageRelation'
        reason:
          type: string
          maxLength: 800
          minLength: 5
          title: Reason
      additionalProperties: false
      type: object
      required:
        - page_id
        - url
        - relationship
        - reason
      title: RelatedExistingPage
    ContentSuggestionProvenance:
      properties:
        research_key:
          type: string
          maxLength: 80
          minLength: 1
          title: Research Key
        seeds:
          items:
            type: string
          type: array
          maxItems: 2
          minItems: 1
          title: Seeds
        language:
          type: string
          maxLength: 10
          minLength: 2
          title: Language
        location_code:
          type: integer
          exclusiveMinimum: 0
          title: Location Code
        timeframe:
          type: string
          maxLength: 80
          minLength: 1
          title: Timeframe
      additionalProperties: false
      type: object
      required:
        - research_key
        - seeds
        - language
        - location_code
        - timeframe
      title: ContentSuggestionProvenance
    EvidenceSourceType:
      type: string
      enum:
        - market_signal
        - official_documentation
        - original_research
        - industry_publication
        - community
        - internal_page
        - brand_first_party_data
        - unknown
      title: EvidenceSourceType
    ProofAvailability:
      type: string
      enum:
        - found
        - brand_contribution_needed
        - research_required
      title: ProofAvailability
    ContentSuggestionEvidenceKind:
      type: string
      enum:
        - google_trends
        - serp
        - citation
        - website
        - gsc
      title: ContentSuggestionEvidenceKind
    ContentSuggestionSignalClass:
      type: string
      enum:
        - top
        - rising
        - breakout
        - citation
        - fanout
        - editorial
      title: ContentSuggestionSignalClass
    ProofReadinessStatus:
      type: string
      enum:
        - ready
        - ready_with_brand_contribution
        - insufficient
      title: ProofReadinessStatus
    SourceVerificationStatus:
      type: string
      enum:
        - signal_verified
        - metadata_only
      title: SourceVerificationStatus
    ContentCoverageRelation:
      type: string
      enum:
        - distinct
        - adjacent
        - overlap
      title: ContentCoverageRelation
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, malformed, or the key is invalid,
        expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Invalid or expired API key
    Forbidden:
      description: >-
        The key is valid but not allowed to do this: the website has no active
        subscription, your role in the workspace is read-only for a write
        request, or your email is not verified.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: >-
              This website has no active subscription, so its data is
              unavailable.
      headers:
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
    NotFound:
      description: >-
        The website, or the resource in the path, does not exist or is not
        visible to this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Website not found
    RateLimited:
      description: >-
        Too many requests for this API key. Wait for the number of seconds in
        `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail: Too many requests. Please try again shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        X-Error-Code:
          description: >-
            Stable machine-readable error code, when one applies (for example
            `rate_limited`).
          schema:
            type: string
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard under Settings > API keys.

````

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