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

# Save keywords to a project

> Saving a keyword already in the list refreshes its metrics rather than failing, which is how you update them after a fresh lookup.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/projects/{projectId}/keywords
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/projects/{projectId}/keywords:
    post:
      tags:
        - keywords
      summary: Save keywords to a project
      description: >-
        Saving a keyword already in the list refreshes its metrics rather than
        failing, which is how you update them after a fresh lookup.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                location_code:
                  type: integer
                  default: 2840
                language_code:
                  type: string
                  default: en
                keywords:
                  type: array
                  items:
                    type: object
                    properties:
                      keyword:
                        type: string
                        minLength: 1
                        maxLength: 200
                      search_volume:
                        type: integer
                        nullable: true
                      keyword_difficulty:
                        type: number
                        nullable: true
                      cpc:
                        type: number
                        nullable: true
                      competition:
                        type: number
                        nullable: true
                      search_intent:
                        type: string
                        nullable: true
                      trend_data:
                        type: array
                        nullable: true
                        items:
                          type: object
                          properties:
                            year:
                              type: integer
                            month:
                              type: integer
                            search_volume:
                              type: integer
                              nullable: true
                          required:
                            - year
                            - month
                            - search_volume
                      serp_features:
                        type: array
                        nullable: true
                        items:
                          type: string
                    required:
                      - keyword
                  minItems: 1
                  maxItems: 500
              required:
                - keywords
      responses:
        '201':
          description: Saved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    nullable: true
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        keyword:
                          type: string
                        search_volume:
                          type: integer
                          nullable: true
                        keyword_difficulty:
                          type: number
                          nullable: true
                        cpc:
                          type: number
                          nullable: true
                        competition:
                          type: number
                          nullable: true
                        search_intent:
                          type: string
                          nullable: true
                        trend_data:
                          type: array
                          nullable: true
                          items:
                            type: object
                            properties:
                              year:
                                type: integer
                              month:
                                type: integer
                              search_volume:
                                type: integer
                                nullable: true
                            required:
                              - year
                              - month
                              - search_volume
                        serp_features:
                          type: array
                          nullable: true
                          items:
                            type: string
                        location_code:
                          type: integer
                        language_code:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - keyword
                        - search_volume
                        - keyword_difficulty
                        - cpc
                        - competition
                        - search_intent
                        - trend_data
                        - serp_features
                        - location_code
                        - language_code
                        - created_at
                required:
                  - success
                  - data

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.