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

# Create a Prompt Research campaign

> Creates a Prompt Research Engine campaign that researches a custom prompt across AI models on a schedule.



## OpenAPI

````yaml /api-reference/openapi.json post /prompt-research/campaigns
openapi: 3.1.0
info:
  title: Keupera Public API
  version: 1.0.0
  description: >-
    Programmatic access to every major Keupera module — Keyword Research,
    Backlinks, Content, AI Visibility, and Analytics.


    All endpoints are served under `https://app.keupera.com/api/v1` and
    authenticated with a Bearer API key. Responses are JSON and follow a
    consistent `{ "data": ... }` envelope, with list endpoints adding a `meta`
    object for pagination.
  contact:
    name: Keupera Support
    email: ask@support.keupera.com
    url: https://keupera.com
  x-logo:
    url: /logo/light.svg
servers:
  - url: https://app.keupera.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Keywords
    description: >-
      Research, enrich, and manage keywords and keyword groups. List, add,
      delete, star, bulk-update status, trigger AI keyword research jobs, and
      organize keywords into groups.
  - name: Backlinks
    description: >-
      Run backlink research campaigns, manage the opportunities discovered for
      each campaign, and generate or send personalized outreach emails.
  - name: Content
    description: >-
      Plan, generate, update, and publish AI-written articles across the full
      content pipeline, and configure per-website content automation.
  - name: AI Visibility
    description: >-
      Track how your brand and competitors appear across LLM answers via Brand
      Radar campaigns, the Prompt Research Engine, and a consolidated visibility
      score.
  - name: Analytics
    description: >-
      Query website traffic, cached Google Search Console data, and AI bot crawl
      activity for a website.
  - name: Account & Utilities
    description: >-
      Verify credentials, connect CMS integrations, and reference internal
      endpoints.
paths:
  /prompt-research/campaigns:
    post:
      tags:
        - AI Visibility
      summary: Create a Prompt Research campaign
      description: >-
        Creates a Prompt Research Engine campaign that researches a custom
        prompt across AI models on a schedule.
      operationId: createPromptResearchCampaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - custom_prompt
              properties:
                website_id:
                  type: string
                  format: uuid
                custom_prompt:
                  type: string
                  description: The prompt to research across AI models.
                frequency:
                  type: integer
                  default: 7
                  description: Run frequency in days.
                languages:
                  type: array
                  items:
                    type: string
                  description: Language codes (max 3).
                  default:
                    - en
            example:
              website_id: b3f1...
              custom_prompt: What are the best SEO tools for small businesses?
              frequency: 7
              languages:
                - en
      responses:
        '201':
          description: Campaign created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PromptResearchCampaign'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
components:
  schemas:
    PromptResearchCampaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        custom_prompt:
          type: string
          example: What are the best SEO tools?
        frequency:
          type: integer
          example: 7
        languages:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - active
            - paused
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      description: Standard error envelope.
      properties:
        error:
          type: string
          description: Descriptive error message.
  responses:
    BadRequest:
      description: Bad request — missing or invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 'Missing required field: keywords'
    Unauthorized:
      description: Unauthorized — missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid or missing API key
    PaymentRequired:
      description: >-
        Usage limit reached — crawl credits, AI credits, or other quota
        exhausted. Enable metered billing to allow overage.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Usage limit reached for keyword_research
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your Keupera API key as a Bearer token: `Authorization: Bearer
        YOUR_KEUPERA_API_KEY`. Generate keys from **Account → API Keys** in your
        Keupera dashboard.

````