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

# Keyword ideas from a seed



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/keywords/suggestions
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/keywords/suggestions:
    post:
      tags:
        - keywords
      summary: Keyword ideas from a seed
      parameters:
        - schema:
            type: string
            format: uuid
          required: false
          name: org_id
          in: query
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                location_code:
                  type: integer
                  default: 2840
                language_code:
                  type: string
                  default: en
                seed_keyword:
                  type: string
                  minLength: 1
                  maxLength: 200
                limit:
                  type: integer
                  minimum: 1
                  maximum: 200
                  default: 50
                project_id:
                  type: string
                  format: uuid
              required:
                - seed_keyword
      responses:
        '200':
          description: Suggestions
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            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
                            competition_index:
                              type: number
                              nullable: true
                            competition_level:
                              type: string
                              nullable: true
                            low_top_of_page_bid:
                              type: number
                              nullable: true
                            high_top_of_page_bid:
                              type: number
                              nullable: true
                            location_code:
                              type: integer
                              nullable: true
                            language_code:
                              type: string
                              nullable: true
                            search_intent:
                              type: string
                              nullable: true
                            trend:
                              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
                          required:
                            - keyword
                            - search_volume
                            - keyword_difficulty
                            - cpc
                            - competition
                            - competition_index
                            - competition_level
                            - low_top_of_page_bid
                            - high_top_of_page_bid
                            - location_code
                            - language_code
                            - search_intent
                            - trend
                      cached:
                        type: boolean
                    required:
                      - data
                      - cached
                required:
                  - success
                  - data
        '402':
          description: Monthly research lookups used up, or no active plan
          content:
            application/json:
              schema:
                type: object
                properties: {}

````

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