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

# Start a research job

> `input_params` depends on `research_type`: `keywords` for bulk, `seed_keywords` for suggestions, `domain` for domain_keywords.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/projects/{projectId}/keywords/research
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/research:
    post:
      tags:
        - keywords
      summary: Start a research job
      description: >-
        `input_params` depends on `research_type`: `keywords` for bulk,
        `seed_keywords` for suggestions, `domain` for domain_keywords.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    research_type:
                      type: string
                      enum:
                        - bulk
                    input_params:
                      type: object
                      properties:
                        location_code:
                          type: integer
                          default: 2840
                        language_code:
                          type: string
                          default: en
                        keywords:
                          type: array
                          items:
                            type: string
                            minLength: 1
                            maxLength: 200
                          minItems: 1
                          maxItems: 1000
                      required:
                        - keywords
                  required:
                    - research_type
                    - input_params
                - type: object
                  properties:
                    research_type:
                      type: string
                      enum:
                        - suggestions
                    input_params:
                      type: object
                      properties:
                        location_code:
                          type: integer
                          default: 2840
                        language_code:
                          type: string
                          default: en
                        seed_keywords:
                          type: array
                          items:
                            type: string
                            minLength: 1
                            maxLength: 200
                          minItems: 1
                          maxItems: 20
                        limit:
                          type: integer
                          minimum: 1
                          maximum: 200
                          default: 50
                      required:
                        - seed_keywords
                  required:
                    - research_type
                    - input_params
                - type: object
                  properties:
                    research_type:
                      type: string
                      enum:
                        - domain_keywords
                    input_params:
                      type: object
                      properties:
                        location_code:
                          type: integer
                          default: 2840
                        language_code:
                          type: string
                          default: en
                        domain:
                          type: string
                          minLength: 1
                        limit:
                          type: integer
                          minimum: 1
                          maximum: 500
                          default: 100
                      required:
                        - domain
                  required:
                    - research_type
                    - input_params
      responses:
        '202':
          description: Queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      job_id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - pending
                      record_id:
                        type: string
                        nullable: true
                        format: uuid
                    required:
                      - job_id
                      - status
                      - record_id
                required:
                  - success
                  - data
        '402':
          description: >-
            The job's cost (one lookup per 1,000 keywords, or per seed) is more
            than the research lookups left, 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.