Generate keywords for search

curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/search-criteria/keywords \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userPrompt": "Find AI-powered transcription services that serve enterprise healthcare customers",
  "marketName": "AI Healthcare Transcription Services",
  "marketType": "service",
  "marketRole": "serviceProvider",
  "keywords": {
    "features": [
      "AI transcription",
      "speech-to-text",
      "healthcare"
    ],
    "user": [
      "healthcare",
      "enterprise",
      "hospitals"
    ],
    "synonyms": [
      "transcription",
      "dictation",
      "voice-to-text"
    ],
    "irrelevant": [
      "manual transcription",
      "human transcription"
    ]
  },
  "seedDomains": [],
  "count": 50,
  "locations": [
    {
      "country": "GB",
      "address": [
        "123 Healthcare St",
        "Suite 100"
      ],
      "coordinates": [
        51.5074,
        -0.1278
      ]
    }
  ]
}
'

{
  "metadata": {},
  "data": [
    "medical transcription software",
    "healthcare AI transcription",
    "enterprise clinical documentation",
    "HIPAA compliant transcription services",
    "medical voice recognition software",
    "automated clinical notes",
    "healthcare speech-to-text solutions",
    "hospital dictation systems"
  ]
}

POST

discovery

search-criteria

keywords

Generate keywords for search

curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/search-criteria/keywords \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "userPrompt": "Find AI-powered transcription services that serve enterprise healthcare customers",
  "marketName": "AI Healthcare Transcription Services",
  "marketType": "service",
  "marketRole": "serviceProvider",
  "keywords": {
    "features": [
      "AI transcription",
      "speech-to-text",
      "healthcare"
    ],
    "user": [
      "healthcare",
      "enterprise",
      "hospitals"
    ],
    "synonyms": [
      "transcription",
      "dictation",
      "voice-to-text"
    ],
    "irrelevant": [
      "manual transcription",
      "human transcription"
    ]
  },
  "seedDomains": [],
  "count": 50,
  "locations": [
    {
      "country": "GB",
      "address": [
        "123 Healthcare St",
        "Suite 100"
      ],
      "coordinates": [
        51.5074,
        -0.1278
      ]
    }
  ]
}
'

{
  "metadata": {},
  "data": [
    "medical transcription software",
    "healthcare AI transcription",
    "enterprise clinical documentation",
    "HIPAA compliant transcription services",
    "medical voice recognition software",
    "automated clinical notes",
    "healthcare speech-to-text solutions",
    "hospital dictation systems"
  ]
}

Overview

This endpoint generates AI-suggested keywords to help refine and improve your search criteria for better discovery results.

Workflow Step: This is an optional refinement step in Phase 1 of the Market Research Workflow.

Usage

Use this endpoint to enhance your search criteria with AI-suggested keywords:

Refinement: Improve existing search criteria with better keywords
Discovery: Find relevant terms you might have missed
Optimization: Get more targeted and comprehensive search results

Best Practices

Optional Step: This endpoint is not required but can significantly improve your discovery results by suggesting relevant keywords you might not have considered.

Important: Review the suggested keywords carefully before using them in your discovery process. Not all suggestions may be relevant to your specific use case.

Authorizations

x-api-key

string

header

required

Pass a static API key for every request, provided by your customer support.

Body

application/json

searchCriteria

object

required

Show child attributes

searchCriteria.userPrompt

string

required

Prompt used to generate the search criteria.

searchCriteria.marketName

string

required

Name of the market associated with the study.

searchCriteria.marketType

enum<string>

required

Type classification of the market, such as region or category.

Available options:

service,

product

searchCriteria.marketRole

enum<string>

required

Try to limit the companies to ones that fit a specific role in the market. Possible values are:

"manufacturer" – physical product manufacturing, e.g. a car manufacturer
"distributor" – physical product distribution, e.g. a car dealership
"service provider" – contractor or provider of pre-defined services, e.g. a car repair shop
"consultant" – consultants or advisers not themselves participating in the market, but offer advice to those who do, e.g. a motor regulatory consultant

This is a hint to the discovery process and does not guarantee that all returned companies will fit this role. If insufficient companies are found, the search will be broadened to include other roles.

If not provided, the AI will attempt to infer the role based on the market name, and assumes "manufacturer" if the market is too broad.

💡 It is recommended to write your intended role in the market name, which the AI will be able to infer from. Supplying a marketRole incompatible with the market name might degrade the output.

Available options:

manufacturer,

distributor,

serviceProvider,

service provider,

consultant,

provider

searchCriteria.keywords

object

required

Grouped keywords associated with the search criteria.

Show child attributes

searchCriteria.keywords.features

string[]

required

Keywords related to the market's features.

searchCriteria.keywords.user

string[]

required

Keywords related to user preferences or behavior.

searchCriteria.keywords.synonyms

string[]

required

Alternative terms related to the market search.

searchCriteria.keywords.irrelevant

string[]

required

Terms identified as irrelevant for the search criteria.

searchCriteria.locations

object[]

required

List of country relevant to the study.

Show child attributes

searchCriteria.locations.country

string | null

required

searchCriteria.locations.address

string[] | null

required

searchCriteria.locations.coordinates

number[] | null

required

Required array length: 2 elements

searchCriteria.seedDomains

string[]

List of company domains you already know (if any).

searchCriteria.assertions

any | null

Assumptions made during the search criteria generation process.

searchCriteria.constraints

any | null

Constraints applied to the search criteria generation process.

Response

Search criteria keywords generated

metadata

object

required

data

string[]

required

List of keywords for the search.

Generate search criteria Start discovery for new market

⌘I

Quick Start

Guides

API Reference

UI Components

Generate keywords for search

Overview

Usage

Best Practices

Authorizations

Body

Response

Quick Start

Guides

API Reference

UI Components

​Overview

​Usage

​Best Practices

Authorizations

Body

Response

Overview

Usage

Best Practices