> ## Documentation Index > Fetch the complete documentation index at: https://bisibility.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Research keywords > Researches or estimates keywords from one seed and requires write scope. ## OpenAPI ````yaml /openapi.snapshot.json get /projects/{project_id}/keyword-research openapi: 3.1.0 info: description: >- Public REST API for bisibility keyword rank tracking. Clients may optionally declare v1 with the Bisibility-API-Version header. Resource IDs use strict v3 prefixed public IDs and list cursors are version 3. title: bisibility Public API version: 1.0.0 servers: - url: /api/v1 security: [] tags: - description: >- Discover the API contract, capabilities, health, and public provider pricing. name: discovery x-group: Discovery - description: Manage the authenticated account and personal access tokens. name: account-access x-group: Account & Access - description: Create projects and manage their core settings. name: projects x-group: Projects - description: Create, list, and revoke API keys. name: api-keys x-group: API Keys - description: Manage tracked keywords and exact keyword matching. name: keywords x-group: Keywords - description: Run rank checks and retrieve rank-check history. name: rank-checks x-group: Rank Checks - description: Research keywords, metrics, locations, and ranked keyword suggestions. name: keyword-research x-group: Keyword Research - description: Analyze backlinks and page through backlink snapshots. name: backlinks x-group: Backlinks - description: Analyze domain visibility and load its history, keywords, and pages. name: domain-overview x-group: Domain Overview - description: Read project analytics, traffic snapshots, and search-performance data. name: analytics x-group: Analytics - description: Manage alert rules, triggered alerts, and notification preferences. name: alerts x-group: Alerts - description: Manage project competitors. name: competitors x-group: Competitors - description: Inspect and configure project sitemap monitoring. name: sitemap-monitoring x-group: Sitemap Monitoring - description: Save keywords for later without putting them under rank tracking. name: saved-keywords x-group: Saved Keywords - description: Create, list, and delete saved views. name: saved-views x-group: Saved Views - description: Ingest and list project signals. name: signals x-group: Signals - description: Connect and configure external providers. name: providers x-group: Providers - description: Create and manage webhook endpoints. name: webhooks x-group: Webhooks - description: Manage team members and invitations. name: team x-group: Team - description: Manage migration tokens and instance import sessions. name: migration x-group: Migration paths: /projects/{project_id}/keyword-research: get: tags: - keyword-research summary: Research keywords description: Researches or estimates keywords from one seed and requires write scope. operationId: researchKeywords parameters: - description: >- API contract version requested by the client. Omit this header to use the current backward-compatible behavior. in: header name: Bisibility-API-Version required: false schema: enum: - v1 type: string - in: query name: seed required: true schema: maxLength: 80 minLength: 1 type: string - in: query name: mode schema: default: auto enum: - auto - related - suggestions - ideas type: string - in: query name: result_limit schema: default: 100 enum: - 100 - 300 - 500 type: integer - in: query name: connection_id schema: pattern: ^conn_[a-z][a-z0-9]{23}$ type: string - description: Use clickstream-refined volume metrics. Provider cost is doubled. in: query name: include_clickstream schema: default: false type: boolean - in: query name: fresh schema: default: false type: boolean - description: Return a free cache-aware provider cost estimate without a lookup. in: query name: estimate_only schema: default: false type: boolean - description: Best-effort maximum provider cost for this request, in cents. in: query name: max_cost_cents schema: minimum: 1 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/KeywordResearchResponse' description: JSON response '400': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Not found '409': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: Unsupported API version '422': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Unsupported provider location or provider reauthorization required '429': content: application/json: schema: $ref: '#/components/schemas/Problem' description: Rate limited security: - ProjectApiKey: [] - PersonalAccessToken: [] components: schemas: KeywordResearchResponse: properties: cached: type: boolean connections: items: properties: id: pattern: ^conn_[a-z][a-z0-9]{23}$ type: string label: type: string provider: type: string required: - id - label - provider type: object type: array cost_cents: minimum: 0 type: number estimate: type: boolean fetched_at: format: date-time type: string provider: type: string rows: items: properties: already_tracked: type: boolean competition: maximum: 1 minimum: 0 type: - number - 'null' cpc_cents: minimum: 0 type: - integer - 'null' difficulty: maximum: 100 minimum: 0 type: - number - 'null' intent: enum: - informational - commercial - transactional - navigational - unknown - null keyword: type: string monthly_trend: items: properties: month: maximum: 12 minimum: 1 type: integer search_volume: type: - number - 'null' year: type: integer required: - year - month - search_volume type: object maxItems: 12 type: array search_volume: minimum: 0 type: - number - 'null' source: enum: - related - suggestion - idea type: string required: - keyword - source - already_tracked - competition - cpc_cents - difficulty - intent - monthly_trend - search_volume type: object type: array sources: items: properties: cached: type: boolean cost_cents: minimum: 0 type: number reason: enum: - budget_exhausted - cost_limit - in_progress - needs_reauth - no_source - previous_source_failed - provider_error - rate_limited - result_limit - unsupported_location type: string returned: minimum: 0 type: integer source: enum: - related - suggestion - idea type: string status: enum: - ok - failed - skipped type: string required: - source - status - returned - cost_cents - cached type: object type: array total_count: minimum: 0 type: integer required: - rows - sources - total_count - cost_cents - cached - fetched_at - provider - connections type: object Problem: properties: detail: type: string docs_url: type: string errors: {} instance: type: string status: type: integer title: type: string type: type: string required: - type - title - status - detail - instance - docs_url type: object securitySchemes: ProjectApiKey: bearerFormat: bsb_key_live_... description: >- Project-scoped API key. It cannot access account routes or create additional projects. scheme: bearer type: http PersonalAccessToken: bearerFormat: bsb_pat_live_... description: >- Personal access token for account routes and projects visible to the authenticated user. scheme: bearer type: http ````