API Reference
Deep Research
Initiate and monitor deep research jobs that combine multiple search variations with optional email enrichment
POST
Deep research is an advanced search feature that combines multiple search variations and optional email enrichment to provide comprehensive results. The process is asynchronous and uses a job-based system.
Initiate Deep Research
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
query | string | Yes | The search query to research |
limit | integer | No | Maximum number of results to return (default: 30, max: 100) |
school | array | No | Filter results by school names |
enrich_emails | boolean | No | Whether to enrich results with contact information (default: true) |
acceptance_threshold | number | No | Acceptance score threshold (0-100) for a match (default: 85) |
Response
Get Research Status
Response (Processing)
Response (Completed)
Response (Error)
Error Responses
Status Code | Description |
---|---|
401 | Unauthorized - API key missing or invalid |
402 | Payment Required - Insufficient credits |
403 | Forbidden - Not authorized to access this job |
404 | Not Found - Job not found |
Notes
- Deep research jobs can take several minutes to complete
- The process involves:
- Generating multiple query variations
- Running parallel searches with each variation
- Deduplicating results
- Optionally enriching profiles with contact information
- Results are cached for future similar queries
- Each result costs 1 credit
- Email enrichment is performed using the contact information endpoint
Authorizations
API key must be provided as a Bearer token in the Authorization header
Body
application/json
Response
200
application/json
Deep research job initiated successfully
The response is of type object
.