Skip to main content
POST
Semantic Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Semantic search criteria including search prompt and entity type

prompt
string
required

The search prompt to apply.

Required string length: 1 - 500
Example:

"Fintech companies based in the United States with over 50 employees"

limit
integer<int32>
default:100

Number of items to include in the response.

Required range: 1 <= x <= 100
Example:

10

entityType
string

The type of entity to search for.

Allowed value: "companies"
Example:

"companies"

listIds
integer<int64>[]

The IDs of the lists to filter results by.

Maximum array length: 100
Required range: 1 <= x <= 9007199254740991
Example:

Response

Created

Includes the list of entities that matched the search prompt and the explanation for the search.

data
companies.SemanticSearchCompany · object[]
required

The list of entities that matched the search prompt

Maximum array length: 100
entityType
string
required

The type of entity that was searched.

Allowed value: "companies"
Example:

"companies"

explanation
string
required
Example:

"This result matched the search criteria."