Search companies using a prompt
Describe the companies you are looking for and our AI model will find them for you.
You can adjust the similarity threshold to enhance the precision of your results.
Signup to access all the features
Get your API token and start implementing the API in your product with 500 free credits.
No credit card required
The prompt our AI model will use to search for companies.
…/companies/by-prompt?prompt=universities in the united states
Comma-separated IDs of your lists containing companies to exclude from the results.
/companies/by-prompt?listsToExclude=3920,3925
The page to fetch (default to 1).
/companies/by-prompt?page=1
The similarity threshold to use for the search (between 0 and 2). Default to 1.875.
/companies/by-prompt?similarity=0.75
Whether to return a simplified version of the company profile. Default to false.
/companies/by-prompt?simplified=true
The number of companies to be returned (between 1 and 25). Default to 10.
/companies/by-prompt?size=10
An array of multiple fields combined to sort the results.
…/companies/by-prompt?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Make sure this parameter is stringified and encoded.
The field to sort the results.
…/companies/by-prompt?sortKey=meta.score
Possible values
The order to sort the results.
…/companies/by-prompt?sortOrder=asc
Possible values
The metas information.
import createClient from '@thecompaniesapi/sdk'
const tca = createClient({ apiToken: 'YOUR_API_TOKEN' })
const response = await tca.searchCompaniesByPrompt({
prompt: 'SaaS Companies in the United States with more than 100 employees',
size: 25
})
const companies = response.data.companies // Companies that match the prompt
const meta = response.data.meta // Meta information