---
title: "Research keywords"
method: GET
path: "/projects/{project_id}/keyword-research"
tags: ["keyword-research"]
---

# Research keywords

`GET /projects/{project_id}/keyword-research`

## Request

- Base URL: `https://eu.bisibility.com/api/v1`
- URL: `https://eu.bisibility.com/api/v1/projects/{project_id}/keyword-research`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `/api/auth/oauth2/authorize`, token URL `/api/auth/oauth2/token`, scopes: `api:write`)

Researches or estimates keywords from one seed and requires write scope. estimate_only=true needs only read scope and never spends provider budget.

## Path parameters

- `project_id` string, required: Public project ID; membership and token scope are enforced.

## Query parameters

- `seed` string, required
- `mode` 'auto' | 'related' | 'suggestions' | 'ideas'
- `result_limit` 100 | 300 | 500
- `connection_id` string
- `include_clickstream` boolean
- `fresh` boolean
- `estimate_only` boolean
- `max_cost_cents` integer

## Headers

- `Bisibility-API-Version` 'v1'
- `X-Bisibility-Source` 'sdk' | 'cli' | 'mcp'

## Response `200`

JSON response

- union
  - object: Free dry run returned for estimate_only=true. It carries per-source cost facts only and never rows, fetch times, or source statuses, so it cannot be mistaken for an empty result.
    - `cached` boolean, required: Every planned source is cached.
    - `connections` object[], required
      - `id` string, required
      - `label` string, required
      - `provider` string, required
    - `cost_cents` number, required
    - `estimate` true, required
    - `provider` string, required
    - `sources` object[], required
      - `cached` boolean, required
      - `cost_cents` number, required
      - `source` 'related' | 'suggestion' | 'idea', required
  - object
    - `cached` boolean, required
    - `connections` object[], required
      - `id` string, required
      - `label` string, required
      - `provider` string, required
    - `cost_cents` number, required
    - `fetched_at` string, date-time, required
    - `provider` string, required
    - `rows` object[], required
      - `already_tracked` boolean, required
      - `keyword` string, required
      - `source` 'related' | 'suggestion' | 'idea', required
      - `competition` number, nullable, required
      - `cpc_cents` integer, nullable, required
      - `difficulty` number, nullable, required
      - `intent` unknown, required
      - `monthly_trend` object[], required
        - `month` integer, required
        - `search_volume` number, nullable, required
        - `year` integer, required
      - `search_volume` number, nullable, required
    - `sources` object[], required
      - `cached` boolean, required
      - `cost_cents` number, required
      - `reason` 'budget_exhausted' | 'cost_limit' | 'in_progress' | 'needs_reauth' | 'no_source' | 'previous_source_failed' | 'provider_error' | 'rate_limited' | 'result_limit' | 'unsupported_location'
      - `returned` integer, required
      - `source` 'related' | 'suggestion' | 'idea', required
      - `status` 'ok' | 'failed' | 'skipped', required
    - `total_count` integer, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `402`: Deployment credits exhausted for a paid provider request
- `403`: Forbidden, or `byok_required`: the account runs paid provider work only on its own provider keys and none serves this request
- `404`: Not found
- `409`: Unsupported API version
- `422`: Unsupported provider location or provider reauthorization required
- `429`: Rate limited

## Changes

- **2026-10-19** `a6e1ec0dec82`: 1 breaking, 7 info
  - added the new path request parameter `project_id`
  - the endpoint scheme security `AppOAuth` was added to the API
  - media type `application/json` was changed to a more specific media type `application/problem+json` for the response status `400`
  - media type `application/json` was changed to a more specific media type `application/problem+json` for the response status `401`
  - …4 more

[Operation history](https://skmtc.dev/bisibility/apis/bisibility-public-api/changes/projects/:project_id/keyword-research/get.md)

---

[API](https://skmtc.dev/bisibility/apis/bisibility-public-api.md) · [All operations](https://skmtc.dev/bisibility/apis/bisibility-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bisibility/apis/bisibility-public-api/revisions/a6e1ec0dec82?raw)