---
title: "Research Seo Keywords"
method: POST
path: "/seo/keywords/research"
tags: ["SEO"]
---

# Research Seo Keywords

`POST /seo/keywords/research`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/seo/keywords/research`
- Auth: HTTP bearer

SPENDS CREDITS. Keyword ideas around a seed, from the paid data provider.

`mode` picks the provider report: `ideas`, `related`, `suggestions`, or
`auto` to let the app choose. Rows come back in that report's own shape.

Runs the app's per-organisation provider rate limit (429 past it) and its
fail-closed credit check (402 when the balance is exhausted) before
anything is fetched. A provider outage is a 502 that says so.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SeoResearchKeywordsRequest: Mirrors `ResearchKeywordsRequest`. `limit` is capped at 150 - the same ceiling the app, the agent tool and the UI share - so a larger ask is a 422 here rather than a silent truncation.
  - `seed_keyword` string, required
  - `mode` 'auto' | 'ideas' | 'related' | 'suggestions'
  - `limit` integer
  - `location_code` integer
  - `language_code` string

## Response `200`

Successful Response

- ApiResponseSeoResearchKeywordsResponse
  - `data` SeoResearchKeywordsResponse, required: Mirrors `ResearchKeywordsResponse`. `keywords` rows are the provider's row shape for the chosen `mode`, passed through rather than flattened, because the four modes return different columns and flattening would drop the ones a caller asked for.
    - `seed` SeoKeywordRow: Mirrors `KeywordRow`.
      - `keyword` string, required
      - `search_volume` integer
      - `keyword_difficulty` integer, nullable
      - `cpc` number, nullable
      - `cpc_high` number, nullable
      - `competition` number
      - `intent` string, nullable
      - `intents` string[]
      - `search_volume_avg` integer, nullable
      - `volume_spike` boolean
      - `trend` integer[]
      - `parent_topic` string, nullable
      - `parent_topic_volume` integer, nullable
      - `serp_features` string[]
      - `results_count` integer, nullable
    - `keywords` object[]
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)