API Reference
WebSocket Search
WSS
Messages
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
Message Parameters
Parameter | Type | Required | Description |
---|---|---|---|
query | string | Yes | Natural language search query |
limit | integer | No | Maximum number of results (default: 30, max: 100) |
school | array | No | Filter by school names |
company | array | No | Filter by company names (current or past employers) |
acceptance_threshold | integer | No | Match score threshold 0-100 (default: 73) |
api_key | string | Yes | Your API key for authentication |
Server Response Message
Messages