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

# Add keywords

> Adds one or more keywords to your workspace. Duplicates are silently skipped. Returns the count of newly inserted keywords.



## OpenAPI

````yaml https://api.rankspot.ai/docs-json post /v1/keywords
openapi: 3.0.0
info:
  title: RankSpot Public API
  description: >-
    The RankSpot Public API gives you programmatic access to your workspace data
    — keywords, backlinks, competitors, content topics, articles, and more.


    ## Authentication


    All endpoints require a Bearer API key in the `Authorization` header:


    ```

    Authorization: Bearer <your-api-key>

    ```


    Generate API keys from **Settings → API Keys** in the RankSpot dashboard.
    Each key is scoped to a single workspace.


    ## Pagination


    List endpoints return a consistent envelope:


    ```json

    {
      "data": {
        "total": 120,
        "offset": 0,
        "limit": 20,
        "count": 20,
        "items": [...]
      }
    }

    ```


    Use `offset` and `limit` query parameters to paginate. Default limit is
    **20**, maximum is **100**.


    ## Status codes


    | Code | Meaning |

    |------|---------|

    | 200  | Success |

    | 201  | Created |

    | 204  | No content (delete / unarchive) |

    | 400  | Validation error or business rule violation |

    | 401  | Missing or invalid API key |

    | 404  | Resource not found or belongs to another workspace |
  version: '1.0'
  contact: {}
servers:
  - url: https://api.rankspot.ai
    description: Production
security: []
tags:
  - name: Articles
    description: >-
      AI-generated blog articles. Articles are created automatically when a
      topic is sent to generation — they cannot be created directly via the API.
  - name: Backlinks
    description: >-
      Backlinks discovered for your domain and your competitors' domains.
      Backlinks are auto-synced on a background interval and cannot be created
      via the API.
  - name: Categories
    description: Categories for organising topics and articles within your workspace.
  - name: Competitors
    description: >-
      Competitor domains tracked in your workspace. Once added, keywords and
      backlinks for each competitor are fetched asynchronously on a background
      sync interval.
  - name: Forum Opportunities
    description: >-
      Forum threads and community posts surfaced as potential link-building or
      engagement opportunities.
  - name: Keywords
    description: >-
      SEO keywords tracked in your workspace, enriched with search volume,
      competition, and AI-generated relevance scores.
  - name: People Also Ask
    description: >-
      "People also ask" questions discovered from search results for your
      tracked keywords.
  - name: Topics
    description: >-
      Content topic ideas that can be turned into articles. Create topics
      manually or let RankSpot generate them from your keyword clusters.
  - name: Search Console
    description: >-
      Google Search Console performance data — clicks, impressions, CTR, and
      average position for your connected property. Requires GSC to be connected
      from the RankSpot dashboard.
paths:
  /v1/keywords:
    post:
      tags:
        - Keywords
      summary: Add keywords
      description: >-
        Adds one or more keywords to your workspace. Duplicates are silently
        skipped. Returns the count of newly inserted keywords.
      operationId: KeywordsController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKeywordsDto'
      responses:
        '201':
          description: >-
            `{ count: number }` — number of newly inserted keywords (duplicates
            excluded).
      security:
        - bearer: []
components:
  schemas:
    CreateKeywordsDto:
      type: object
      properties:
        keywords:
          description: List of keywords to track
          example:
            - seo tools
            - keyword research
          type: array
          items:
            type: string
      required:
        - keywords
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````