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

> Creates a backlink research campaign. Opportunity research is triggered automatically in the background once the campaign is created. Consumes backlink research credits.



## OpenAPI

````yaml /api-reference/openapi.json post /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:
  /campaigns:
    post:
      tags:
        - Backlinks
      summary: Create campaign
      description: >-
        Creates a backlink research campaign. Opportunity research is triggered
        automatically in the background once the campaign is created. Consumes
        backlink research credits.
      operationId: createCampaign
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - keyword
                - niche
              properties:
                website_id:
                  type: string
                  format: uuid
                keyword:
                  type: string
                  description: Target keyword for backlink research.
                niche:
                  type: string
                  description: Industry / niche context.
                language:
                  type: string
                  description: Language code. Defaults to the website language.
                target_domain:
                  type: string
                  description: >-
                    Domain to research backlinks for. Defaults to the website's
                    own domain. Useful for a subdomain or partner site.
            example:
              website_id: b3f1...
              keyword: seo tools
              niche: Digital Marketing
              language: en
              target_domain: myblog.com
      responses:
        '201':
          description: Campaign created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Campaign'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
components:
  schemas:
    Campaign:
      type: object
      properties:
        id:
          type: string
          format: uuid
        keyword:
          type: string
          example: seo tools
        niche:
          type: string
          example: Digital Marketing
        status:
          type: string
          example: active
        language:
          type: string
          example: en
        target_domain:
          type: string
          description: The domain being researched for backlinks.
          example: example.com
        is_public:
          type: boolean
          description: Whether campaign results are publicly shared.
        public_share_token:
          type: string
          nullable: true
          description: Token used to construct the public share URL.
        progress:
          type: object
          nullable: true
          additionalProperties: true
          description: Research job progress (phase and counts).
        general_strategies:
          type: array
          items:
            type: object
            additionalProperties: true
        websites:
          type: object
          properties:
            url:
              type: string
              format: uri
        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.

````