0.1.0
OAS 3.1.0
AlphaLens-API
Production environment
Client Libraries
Search
Search Similar Products
Search for similar products based on the description of a given product.
Access Control:
- Enforces monthly search limit per company (20 searches per month).
- Super Admins have no limits.
Args:
- product_id (int): The ID of the product to use as a reference.
- services (bool, optional): Whether to include services in the search. Defaults to False.
- limit (int, optional): Maximum number of results to return. Defaults to 100.
Returns:
- List[ProductSearchResponse]: A list of similar products.
Raises:
- HTTPException (401): If the token is invalid or expired.
- HTTPException (403): If the user has exceeded their search limit.
- HTTPException (404): If the product is not found.
- HTTPException (500): If there are issues with the external API or unexpected errors.
Path Parameters
- product_idintegerrequired
Integer numbers.
Query Parameters
- servicesbooleandefault:false
- limitintegerdefault:100
Integer numbers.
Responses
GET/api/v1/search/products/{product_id}/similar
[
{
"venture_product_id": 1,
"product_name": "…",
"product_description": "…",
"product_target_audiences": [
"…"
],
"business_models": [
"…"
],
"product_categories": [
"…"
],
"product_references": [
"…"
],
"revenue_models": [
"…"
],
"key_features": [
"…"
],
"pricing": "…",
"reference_snippets": [
"…"
],
"data_source": "alphalens",
"created_at": "2025-01-15T22:35:40.553Z",
"updated_at": "2025-01-15T22:35:40.553Z",
"organization_name": "…",
"city": "…",
"country": "…",
"country_code": "…",
"founded_date": "2025-01-15",
"employee_count": "…",
"employee_count_total": 1,
"employee_count_range_min": 1,
"employee_count_range_max": 1,
"logo_url": "…",
"active_domain": "…",
"linkedin_url": "…"
}
]