Generate search criteria

curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/search-criteria \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "searchType": "keywordSearch",
  "searchInput": "Find AI-powered transcription services that serve enterprise healthcare customers"
}
'

{
  "metadata": {},
  "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
        ]
      }
    ]
  }
}

POST

discovery

search-criteria

Generate search criteria

curl --request POST \
  --url https://rest.forestreet.com/v2/discovery/search-criteria \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "searchType": "keywordSearch",
  "searchInput": "Find AI-powered transcription services that serve enterprise healthcare customers"
}
'

{
  "metadata": {},
  "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
        ]
      }
    ]
  }
}

Overview

This endpoint converts your natural language business question into structured search criteria that our AI algorithms can use to discover relevant companies.

Workflow Step: This is Step 1 of the Market Research Workflow.

Usage

The endpoint accepts a simple search input and returns comprehensive search criteria including:

Market Classification: Type, role, and geographic scope
Keyword Groups: Features, users, synonyms, and irrelevant terms
Search Parameters: Count limits, project type, and constraints

Best Practices

Pro Tip: Be specific in your search input. Instead of “AI companies”, try “AI-powered transcription services for enterprise healthcare customers.”

Important: The generated search criteria will be used in subsequent discovery steps. Take time to review and potentially refine the criteria before proceeding to company discovery.

Authorizations

x-api-key

string

header

required

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

Body

application/json

searchInput

string

required

Input for the search.

searchType

enum<string>

default:keywordSearch

Type of search to perform.

Available options:

keywordSearch,

domainSearch

Response

Search criteria generated

metadata

object

required

data

object

required

Show child attributes

data.userPrompt

string

required

Prompt used to generate the search criteria.

data.marketName

string

required

Name of the market associated with the study.

data.marketType

enum<string>

required

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

Available options:

service,

product

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

data.keywords

object

required

Grouped keywords associated with the search criteria.

Show child attributes

data.keywords.features

string[]

required

Keywords related to the market's features.

data.keywords.user

string[]

required

Keywords related to user preferences or behavior.

data.keywords.synonyms

string[]

required

Alternative terms related to the market search.

data.keywords.irrelevant

string[]

required

Terms identified as irrelevant for the search criteria.

data.locations

object[]

required

List of country relevant to the study.

Show child attributes

data.locations.country

string | null

required

data.locations.address

string[] | null

required

data.locations.coordinates

number[] | null

required

Required array length: 2 elements

data.seedDomains

string[]

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

data.assertions

any | null

Assumptions made during the search criteria generation process.

data.constraints

any | null

Constraints applied to the search criteria generation process.

Move a market Generate keywords for search

⌘I

Quick Start

Guides

API Reference

UI Components

Generate search criteria

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