exa-known-pitfalls
A guide to avoiding incorrect search syntax and common mistakes when integrating Exa's neural search.
Install
mkdir -p .claude/skills/exa-known-pitfalls && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/9370" && unzip -o skill.zip -d .claude/skills/exa-known-pitfalls && rm skill.zipInstalls to .claude/skills/exa-known-pitfalls
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Identify and avoid Exa anti-patterns and common integration mistakes.Key capabilities
- →Identify keyword-style query anti-patterns
- →Audit search type selection
- →Verify content retrieval methods
- →Validate date filter usage
How it works
The skill highlights common failure modes in Exa integrations, such as using Boolean operators in neural search or incorrect search type selection.
Inputs & outputs
When to use exa-known-pitfalls
- →Audit existing Exa code for integration mistakes
- →Debug poor neural search results
- →Train new developers on Exa best practices
- →Switch from keyword to natural language query patterns
About this skill
Exa Known Pitfalls
Overview
Real gotchas when integrating Exa's neural search API. Exa uses embeddings-based search rather than keyword matching, which creates a different class of failure modes than traditional search APIs. This skill covers the top pitfalls with wrong/right examples.
Pitfall 1: Keyword-Style Queries
Exa's neural search interprets natural language semantically. Boolean operators and keyword syntax degrade results.
import Exa from "exa-js";
const exa = new Exa(process.env.EXA_API_KEY);
// BAD: keyword/boolean style — Exa ignores AND/OR
const bad = await exa.search(
"python AND machine learning OR deep learning 2024"
);
// GOOD: natural language statement
const good = await exa.search(
"recent tutorials on building ML models with Python",
{ type: "neural", numResults: 10 }
);
Pitfall 2: Wrong Search Type
Using neural search for exact lookups (URLs, names) or keyword search for conceptual queries silently degrades quality.
// BAD: neural search for a specific URL/identifier
const bad = await exa.search("arxiv.org/abs/2301.00001", { type: "neural" });
// GOOD: keyword for exact terms, neural for concepts
const exactMatch = await exa.search("arxiv.org/abs/2301.00001", {
type: "keyword",
});
const conceptual = await exa.search(
"transformer architecture improvements for long context",
{ type: "neural" }
);
Pitfall 3: Expecting Content from search()
search() returns metadata only (URL, title, score). Content requires searchAndContents() or getContents().
// BAD: accessing .text from search() — it's undefined
const results = await exa.search("AI safety research");
const text = results.results[0].text; // undefined!
// GOOD: use searchAndContents for text/highlights
const withContent = await exa.searchAndContents("AI safety research", {
numResults: 5,
text: { maxCharacters: 2000 },
highlights: { maxCharacters: 500 },
});
console.log(withContent.results[0].text); // actual content
console.log(withContent.results[0].highlights); // key excerpts
Pitfall 4: Narrow Date Filters Return Empty
Date filters silently exclude results. A single-day window often returns nothing without error.
// BAD: too narrow, likely returns empty array
const bad = await exa.search("AI news", {
startPublishedDate: "2025-03-15T00:00:00.000Z",
endPublishedDate: "2025-03-15T23:59:59.000Z",
});
// GOOD: reasonable window with fallback
let results = await exa.search("AI news", {
startPublishedDate: "2025-03-01T00:00:00.000Z",
endPublishedDate: "2025-03-31T23:59:59.000Z",
numResults: 10,
});
// Fallback if no results
if (results.results.length === 0) {
results = await exa.search("AI news", { numResults: 10 });
}
Pitfall 5: findSimilar Takes a URL, Not a Query
findSimilar expects a URL as its first argument. Passing a query string gives meaningless results.
// BAD: passing a query string to findSimilar
const bad = await exa.findSimilar("machine learning research papers");
// GOOD: pass a URL — findSimilar finds pages semantically similar to it
const good = await exa.findSimilar("https://arxiv.org/abs/2301.00001", {
numResults: 10,
excludeSourceDomain: true,
});
Pitfall 6: Date Filters with company/people Categories
The company and people categories do NOT support date filters. Using them returns a 400 error.
// BAD: date filter with company category → 400 error
const bad = await exa.search("AI startups", {
category: "company",
startPublishedDate: "2024-01-01T00:00:00.000Z", // not supported!
});
// GOOD: company search without date filters
const good = await exa.search("AI startups", {
category: "company",
numResults: 10,
});
Pitfall 7: Not Limiting Content Size
Requesting full text without maxCharacters can return massive payloads, increasing latency and cost.
// BAD: unlimited text retrieval
const bad = await exa.searchAndContents("topic", {
numResults: 20,
text: true, // could return megabytes of content
});
// GOOD: limit content size
const good = await exa.searchAndContents("topic", {
numResults: 10,
text: { maxCharacters: 2000 }, // cap at 2000 chars per result
highlights: { maxCharacters: 500 },
});
Pitfall 8: Creating New Client Per Request
Each new Exa() call creates a new HTTP client. Reuse a singleton for connection pooling.
// BAD: new client every request (in a route handler)
app.get("/search", async (req, res) => {
const exa = new Exa(process.env.EXA_API_KEY); // wasteful!
const results = await exa.search(req.query.q);
res.json(results);
});
// GOOD: singleton client
const exa = new Exa(process.env.EXA_API_KEY);
app.get("/search", async (req, res) => {
const results = await exa.search(req.query.q);
res.json(results);
});
Pitfall 9: Ignoring the requestId in Errors
Exa error responses include requestId for support debugging. Always log it.
// BAD: generic error handling
try {
await exa.search("query");
} catch (err) {
console.error("Search failed"); // loses diagnostic info
}
// GOOD: capture requestId
try {
await exa.search("query");
} catch (err: any) {
console.error("Search failed:", {
status: err.status,
message: err.message,
requestId: err.requestId, // include when contacting support
tag: err.error_tag,
});
}
Quick Review Checklist
- Queries are natural language, not keyword/boolean syntax
- Search type matches the query intent (neural vs keyword)
- Using
searchAndContentswhen page content is needed - Date filter windows are wide enough (7+ days)
-
findSimilarreceives URLs, not query strings - No date filters on
companyorpeoplecategories -
maxCharactersset on text and highlights - Exa client is a singleton, not created per request
- Error handling captures
requestId
Resources
Next Steps
For SDK patterns, see exa-sdk-patterns. For common errors, see exa-common-errors.
When not to use it
- →When performing simple keyword-based lookups
- →When using non-neural search endpoints
Limitations
- →Date filters are not supported for company or people categories
- →findSimilar requires a URL, not a query string
How it compares
It focuses on identifying specific semantic search pitfalls rather than general API debugging.
Compared to similar skills
exa-known-pitfalls side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| exa-known-pitfalls (this skill) | 0 | 27d | Review | Beginner |
| api-contract-sync-manager | 1 | 10mo | No flags | Intermediate |
| endpoint-validator | 1 | 9mo | Review | Intermediate |
| exa-upgrade-migration | 1 | 27d | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by jeremylongshore
View all by jeremylongshore →You might also like
api-contract-sync-manager
ananddtyagi
Validate OpenAPI, Swagger, and GraphQL schemas match backend implementation. Detect breaking changes, generate TypeScript clients, and ensure API documentation stays synchronized. Use when working with API spec files (.yaml, .json, .graphql), reviewing API changes, generating frontend types, or validating endpoint implementations.
endpoint-validator
mikopbx
Валидация REST API эндпоинтов на соответствие OpenAPI схеме и консистентность параметров. Использовать при реализации эндпоинтов, ревью кода или перед слиянием изменений API.
exa-upgrade-migration
jeremylongshore
Analyze, plan, and execute Exa SDK upgrades with breaking change detection. Use when upgrading Exa SDK versions, detecting deprecations, or migrating to new API versions. Trigger with phrases like "upgrade exa", "exa migration", "exa breaking changes", "update exa SDK", "analyze exa version".
obsidian-upgrade-migration
jeremylongshore
Migrate Obsidian plugins between API versions and handle breaking changes. Use when upgrading to new Obsidian versions, handling API deprecations, or migrating plugin code to new patterns. Trigger with phrases like "obsidian upgrade", "obsidian migration", "obsidian API changes", "update obsidian plugin".
instantly-sdk-patterns
jeremylongshore
Apply production-ready Instantly SDK patterns for TypeScript and Python. Use when implementing Instantly integrations, refactoring SDK usage, or establishing team coding standards for Instantly. Trigger with phrases like "instantly SDK patterns", "instantly best practices", "instantly code patterns", "idiomatic instantly".
juicebox-sdk-patterns
jeremylongshore
Apply production-ready Juicebox SDK patterns. Use when implementing robust error handling, retry logic, or enterprise-grade Juicebox integrations. Trigger with phrases like "juicebox best practices", "juicebox patterns", "production juicebox", "juicebox SDK architecture".