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

# Add keywords

> Adds one or more keywords to a website. Set `enrich: true` to auto-fill volume, difficulty, CPC, and intent via DataForSEO — this consumes keyword research credits.



## OpenAPI

````yaml /api-reference/openapi.json post /keywords
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:
  /keywords:
    post:
      tags:
        - Keywords
      summary: Add keywords
      description: >-
        Adds one or more keywords to a website. Set `enrich: true` to auto-fill
        volume, difficulty, CPC, and intent via DataForSEO — this consumes
        keyword research credits.
      operationId: addKeywords
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - keywords
              properties:
                website_id:
                  type: string
                  format: uuid
                  description: Target website. Defaults to the API key's website.
                keywords:
                  type: array
                  description: Keyword objects to add.
                  items:
                    $ref: '#/components/schemas/KeywordInput'
                enrich:
                  type: boolean
                  default: false
                  description: Auto-enrich keywords with volume and difficulty data.
            example:
              website_id: b3f1c2d4-1111-2222-3333-444455556666
              keywords:
                - term: seo tools
                  keyword_group: SEO
                - term: keyword research
                  volume: 5000
                  difficulty: 30
              enrich: true
      responses:
        '201':
          description: Keywords created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Keyword'
                  count:
                    type: integer
                    description: Number of keywords created.
              example:
                data:
                  - id: 9a8b...
                    term: seo tools
                    volume: 12000
                count: 2
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    KeywordInput:
      type: object
      required:
        - term
      properties:
        term:
          type: string
          description: 'The keyword term. Alias: `keyword`.'
        keyword_group:
          type: string
          description: 'Group name (auto-created if new). Alias: `group`.'
        volume:
          type: integer
          description: 'Search volume. Auto-filled if `enrich: true`.'
        difficulty:
          type: integer
          description: Keyword difficulty (0–100).
        cpc:
          type: number
          description: Cost per click.
        intent:
          type: string
          description: Search intent.
        opportunity:
          type: string
          enum:
            - High
            - Medium
            - Low
          description: Opportunity level.
        funnel_stage:
          type: string
          enum:
            - awareness
            - consideration
            - decision
        language:
          type: string
          description: Language code.
    Keyword:
      type: object
      properties:
        id:
          type: string
          format: uuid
        term:
          type: string
          example: best seo tools
        volume:
          type: integer
          example: 12000
        difficulty:
          type: integer
          example: 45
        cpc:
          type: number
          example: 2.5
        intent:
          type: string
          example: Commercial
        opportunity:
          type: string
          example: High
        status:
          type: string
          enum:
            - active
            - planned
            - ignored
        is_starred:
          type: boolean
        funnel_stage:
          type: string
          example: consideration
        language:
          type: string
          example: en
        group_id:
          type: string
          format: uuid
          nullable: true
        keyword_groups:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
        blog_posts:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            title:
              type: string
            status:
              type: string
        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
    Forbidden:
      description: >-
        Forbidden — inactive key, no API access on your plan, or the requested
        website is not yours.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Your plan does not include Public API access
  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.

````