WSS
wss://search.linkd.inc
/
api
/
search
/
ws
Messages
Search Request
type:object

Request to search for user profiles

Overview

This WebSocket endpoint allows real-time searching of user profiles using natural language queries.

WebSockets provide several advantages over traditional HTTP endpoints:

  • Persistent Connection - Maintain a single connection for multiple searches
  • Lower Latency - Faster response times with reduced overhead
  • Real-time Updates - Ideal for search-as-you-type scenarios

Message Format

Client Request Message

{
  "query": "software engineers in San Francisco",
  "limit": 30,
  "school": ["Stanford University", "MIT"],
  "company": ["Google", "Facebook", "Apple"],
  "acceptance_threshold": 73,
  "api_key": "your_api_key"
}

Message Parameters

ParameterTypeRequiredDescription
querystringYesNatural language search query
limitintegerNoMaximum number of results (default: 30, max: 100)
schoolarrayNoFilter by school names
companyarrayNoFilter by company names (current or past employers)
acceptance_thresholdintegerNoMatch score threshold 0-100 (default: 73)
api_keystringYesYour API key for authentication

Server Response Message

{
  "results": [...],
  "total": 25,
  "query": "software engineers in San Francisco",
  "cache_hit": false
}