Rechercher des entreprises à l'aide d'un prompt

Décrivez les entreprises que vous recherchez, et notre modèle d'IA les trouvera pour vous.

Vous pouvez ajuster le seuil de similarité pour améliorer la précision de vos résultats.

Inscrivez-vous pour accéder à toutes les fonctionnalités

Recevez votre jeton d'API et commencez à implémenter l'API dans votre produit avec 500 crédits gratuits.

Aucune carte de crédit requise

Paramètres de requête

promptstring (requis)

Le prompt que notre modèle d'IA utilisera pour rechercher des entreprises.

…/companies/by-prompt?prompt=universities in the united states

listsToExcludestring (optionnel)

Les identifiants séparés par des virgules de vos listes contenant les entreprises à exclure des résultats.

/companies/by-prompt?listsToExclude=3920,3925

pagenumber (optionnel)

La page à récupérer (par défaut 1).

/companies/by-prompt?page=1

similaritynumber (optionnel)

Le seuil de similarité à utiliser pour la recherche (entre 0 et 1). Par défaut à 0.75.

/companies/by-prompt?similarity=0.75

simplifiedboolean (optionnel)

S'il faut retourner une version simplifiée du profil de l'entreprise. Par défaut à false.

/companies/by-prompt?simplified=true

sizenumber (optionnel)

Le nombre d'entreprises à retourner (entre 1 et 25). Par défaut à 10.

/companies/by-prompt?size=10

sortFieldsstring (optionnel)

Un array de plusieurs champs combinés pour trier les résultats.

…/companies/by-prompt?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D

Assurez-vous que ce paramètre soir stringifié et encodé.

sortKeystring (optionnel)

Le champ pour trier les résultats.

…/companies/by-prompt?sortKey=meta.score

Valeurs possibles

about.businessType

about.industries

about.industry

about.name

about.totalEmployees

about.yearFounded

analytics.monthlyVisitors

apps

codes.naics

codes.sic

Afficher 13 autres

sortOrderstring (optionnel)

L'ordre pour trier les résultats.

…/companies/by-prompt?sortOrder=asc

Valeurs possibles

asc

desc

Schéma de réponse

companiesarray

La liste des entreprises correspondant à votre prompt.

Parcourir tous les points de données

metaobject

Les informations sur les métas.

Exemples de code

Sélectionnez votre langage favori :

Java

JavaScript

SDK

PHP

Python

Ruby

Rust

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