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

# Create a prompt

> Create a new prompt. Fails if the website's prompt quota is reached.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/public/prompts
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/prompts:
    post:
      tags:
        - Prompts
      summary: Create a prompt
      description: Create a new prompt. Fails if the website's prompt quota is reached.
      operationId: create_prompt_api_v1_public_prompts_post
      parameters:
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromptCreateSchema'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptBaseSchema'
        '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:
    PromptCreateSchema:
      properties:
        content:
          type: string
          title: Content
        topic_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Topic Id
        tag_ids:
          anyOf:
            - items:
                type: integer
              type: array
            - type: 'null'
          title: Tag Ids
        localizations:
          items:
            type: string
          type: array
          title: Localizations
          default:
            - worldwide
        intent:
          anyOf:
            - $ref: '#/components/schemas/PromptIntent'
            - type: 'null'
        journey_stage:
          anyOf:
            - $ref: '#/components/schemas/PromptJourneyStage'
            - type: 'null'
        brand_scope:
          anyOf:
            - $ref: '#/components/schemas/PromptBrandScope'
            - type: 'null'
        source_keyword:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Keyword
      type: object
      required:
        - content
      title: PromptCreateSchema
    PromptBaseSchema:
      properties:
        id:
          type: integer
          title: Id
        content:
          type: string
          title: Content
        topic_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Topic Id
        topic_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic Name
        tags:
          items:
            $ref: '#/components/schemas/TagOnPromptSchema'
          type: array
          title: Tags
          default: []
        localizations:
          items:
            type: string
          type: array
          title: Localizations
          default:
            - worldwide
        intent:
          anyOf:
            - $ref: '#/components/schemas/PromptIntent'
            - type: 'null'
        journey_stage:
          anyOf:
            - $ref: '#/components/schemas/PromptJourneyStage'
            - type: 'null'
        brand_scope:
          anyOf:
            - $ref: '#/components/schemas/PromptBrandScope'
            - type: 'null'
        brand_scope_manual:
          type: boolean
          title: Brand Scope Manual
          default: false
        source_keyword:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Keyword
        visibility:
          type: number
          title: Visibility
          default: 0
        visibility_delta_7d:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Delta 7D
        answer_count:
          type: integer
          title: Answer Count
          default: 0
        visibility_reference:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Reference
        reference_answer_count:
          type: integer
          title: Reference Answer Count
          default: 0
        visibility_delta_reference:
          anyOf:
            - type: number
            - type: 'null'
          title: Visibility Delta Reference
        status:
          $ref: '#/components/schemas/PromptStatus'
          default: unclaimed
        top_platforms:
          items:
            $ref: '#/components/schemas/PromptPlatformBreakdownSchema'
          type: array
          title: Top Platforms
          default: []
        sentiment_score:
          anyOf:
            - type: number
            - type: 'null'
          title: Sentiment Score
        sentiment_highlights_count:
          type: integer
          title: Sentiment Highlights Count
          default: 0
        sentiment_positive_count:
          type: integer
          title: Sentiment Positive Count
          default: 0
        sentiment_negative_count:
          type: integer
          title: Sentiment Negative Count
          default: 0
        sentiment_neutral_count:
          type: integer
          title: Sentiment Neutral Count
          default: 0
        ai_search_volume:
          anyOf:
            - type: integer
            - type: 'null'
          title: Ai Search Volume
        ai_volume_delta:
          anyOf:
            - type: number
            - type: 'null'
          title: Ai Volume Delta
        volume_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Volume Updated At
        is_active:
          type: boolean
          title: Is Active
          default: true
        archived_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Archived At
        archive_reason:
          anyOf:
            - $ref: '#/components/schemas/PromptArchiveReason'
            - type: 'null'
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - content
        - created_at
      title: PromptBaseSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PromptIntent:
      type: string
      enum:
        - informational
        - comparative
        - transactional
        - navigational
      title: PromptIntent
    PromptJourneyStage:
      type: string
      enum:
        - discovery
        - consideration
        - decision
        - retention
      title: PromptJourneyStage
    PromptBrandScope:
      type: string
      enum:
        - branded
        - non_branded
      title: PromptBrandScope
    TagOnPromptSchema:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        color:
          $ref: '#/components/schemas/TagColor'
      type: object
      required:
        - id
        - name
        - color
      title: TagOnPromptSchema
    PromptStatus:
      type: string
      enum:
        - winning
        - at_risk
        - losing
        - unclaimed
      title: PromptStatus
    PromptPlatformBreakdownSchema:
      properties:
        platform:
          $ref: '#/components/schemas/AiPlatform'
        cited_count:
          type: integer
          title: Cited Count
        total_count:
          type: integer
          title: Total Count
      type: object
      required:
        - platform
        - cited_count
        - total_count
      title: PromptPlatformBreakdownSchema
    PromptArchiveReason:
      type: string
      enum:
        - quota
        - user
      title: PromptArchiveReason
    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
    TagColor:
      type: string
      enum:
        - slate
        - red
        - orange
        - amber
        - green
        - teal
        - blue
        - indigo
        - purple
        - pink
      title: TagColor
    AiPlatform:
      type: string
      enum:
        - ChatGPT
        - Gemini
        - AI Overviews
        - Google AI Mode
        - Perplexity
        - Mistral
        - Claude
        - DeepSeek
        - Grok
        - Copilot
        - Bing AI Mode
      title: AiPlatform
  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.