- Test query structure before running on large datasets
- Validate match conditions work as expected
- Iterate quickly on Find All schema and descriptions
How Preview Works
Preview mode uses the same API endpoint as regular Find All runs, but withprocessor: preview. It generates approximately 10 evaluated candidates (both matched and unmatched) to give you a representative sample of results.
Preview vs. Full Run
| Feature | Preview Mode | Full Run |
|---|---|---|
| Processor | preview | base, core, pro |
| Candidates Generated | ~10 evaluated | Until match_limit matches found |
| Match Limit | Max 10 | Max 1000 |
| Speed | Fast (minutes) | Slower (varies by processor) |
| Cost | Flat, cheap | Variable, higher |
| Outputs | Full | Full |
| Enrichments | ❌ No | ✅ Yes |
| Can Extend | ❌ No | ✅ Yes |
| Can Cancel | ❌ No | ✅ Yes |
Key Characteristics
- Fast & Cost-Effective: Much faster and cheaper than full runs
- Sample Size: Generates ~10 evaluated candidates with no guarantee of match rate
- Full Outputs: Candidates include full match outputs, reasoning, and citations (just like regular runs)
- Capped Limit:
match_limitis capped at 10 and interpreted as candidates to evaluate, not matches to find - No Modifications: Cannot be extended or cancelled after creation
Preview candidates follow the same structure as full run candidates. See Candidates for details on candidate object structure and fields.
Quick Example
Best Practices
- Always Preview First: Run preview to validate match conditions before committing to full searches
- Review Both Results: Check matched and unmatched candidates to refine your query logic
- Test Enrichments Early: Validate enrichment outputs in preview before running at scale
- Examine Reasoning: Review the
basisfield to understand how matches were determined - Iterate Quickly: Use preview’s fast feedback loop to refine queries before full runs
Related Topics
- Quickstart Guide: Get started with Find All API
- Generators and Pricing: Understand processor options, pricing, and selectivity requirements
- Enrichments: Extract additional structured data for matched candidates
- Extend Runs: Increase match limits without paying new fixed costs
- Streaming Events: Receive real-time updates via Server-Sent Events
- Webhooks: Configure HTTP callbacks for run completion and matches
- Run Lifecycle: Understand run statuses and how to cancel runs
- API Reference: Complete endpoint documentation