TypeScript SDK Specification

import Exa from "exa-js";

const exa = new Exa();  // Reads EXA_API_KEY from environment
// or explicitly: const exa = new Exa("your-api-key");

const result = await exa.search("hottest AI startups", {
  numResults: 10
});

{
  "autopromptString": "Here is a link to one of the hottest AI startups:",
  "results": [
    {
      "title": "Adept: Useful General Intelligence",
      "id": "https://www.adept.ai/",
      "url": "https://www.adept.ai/",
      "publishedDate": "2000-01-01",
      "author": null,
      "text": "Adept is building AI that can automate any software process..."
    }
  ],
  "requestId": "a78ebce717f4d712b6f8fe0d5d7753f8"
}

const result = await exa.searchAndContents("AI in healthcare", {
  text: true,
  highlights: true,
  numResults: 5
});

{
  "results": [
    {
      "title": "2023 AI Trends in Health Care",
      "id": "https://aibusiness.com/verticals/2023-ai-trends-in-health-care-",
      "url": "https://aibusiness.com/verticals/2023-ai-trends-in-health-care-",
      "publishedDate": "2022-12-29",
      "author": "Wylie Wong",
      "text": "While the health care industry was initially slow to adopt AI...",
      "highlights": [
        "AI is transforming healthcare through improved diagnostics and personalized treatment plans."
      ],
      "highlightScores": [
        0.85
      ]
    }
  ],
  "requestId": "b89fcd823e4f5a91c7d0fe1e6e8864f9"
}

const result = await exa.findSimilar("https://www.example.com/article", {
  numResults: 10,
  excludeSourceDomain: true
});

{
  "results": [
    {
      "title": "Similar Article: AI and Machine Learning",
      "id": "https://www.similarsite.com/ai-ml-article",
      "url": "https://www.similarsite.com/ai-ml-article",
      "publishedDate": "2023-05-15",
      "author": "Jane Doe",
      "text": "Artificial Intelligence (AI) and Machine Learning (ML) are revolutionizing various industries..."
    }
  ],
  "requestId": "08fdc6f20e9f3ea87f860af3f6ccc30f"
}

const result = await exa.findSimilarAndContents("https://www.example.com/article", {
  text: true,
  highlights: true,
  numResults: 5
});

{
  "results": [
    {
      "title": "The Impact of AI on Modern Technology",
      "id": "https://www.techblog.com/ai-impact",
      "url": "https://www.techblog.com/ai-impact",
      "publishedDate": "2023-06-01",
      "author": "John Smith",
      "text": "In recent years, artificial intelligence has made significant strides...",
      "highlights": [
        "AI is reshaping industries and creating new opportunities for innovation."
      ],
      "highlightScores": [
        0.92
      ]
    }
  ],
  "requestId": "c90gde934f5g6b02d8e1gf2f7f9975g0"
}

const result = await exa.getContents([
  "https://www.example.com/article1",
  "https://www.example.com/article2"
], {
  text: { maxCharacters: 1000 },
  highlights: { query: "AI", numSentences: 2 }
});

{
  "results": [
    {
      "url": "https://example.com/article",
      "id": "https://example.com/article",
      "title": "Example Article",
      "text": "The full text content of the article..."
    }
  ]
}

const result = await exa.answer("What is the capital of France?", {
  text: true,
  model: "exa"
});

{
  "answer": "The capital of France is Paris.",
  "citations": [
    {
      "id": "https://www.example.com/france",
      "url": "https://www.example.com/france",
      "title": "France - Wikipedia",
      "publishedDate": "2023-01-01",
      "author": null,
      "text": "France, officially the French Republic, is a country in... [truncated for brevity]"
    }
  ],
  "requestId": "abc123"
}

for await (const chunk of exa.streamAnswer("What is quantum computing?", {
  text: true,
  model: "exa"
})) {
  if (chunk.content) process.stdout.write(chunk.content);
  if (chunk.citations) console.log("Citations:", chunk.citations);
}

{
  "content": "The capital of France is Paris.",
  "citations": [
    {
      "id": "https://www.example.com/france",
      "url": "https://www.example.com/france",
      "title": "France - Wikipedia"
    }
  ]
}

const task = await exa.research.create({
  instructions: "Research the latest AI developments",
  model: "exa-research-fast"
});

{
  "researchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending"
}

const result = await exa.research.get("a1b2c3d4-e5f6-7890-abcd-ef1234567890");

{
  "researchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "instructions": "What is the latest valuation of SpaceX?",
  "output": {
    "parsed": {
      "valuation": "$350 billion",
      "date": "December 2024",
      "source": "Financial Times"
    }
  }
}

const result = await exa.research.pollUntilFinished("a1b2c3d4-e5f6-7890-abcd-ef1234567890", {
  pollInterval: 1000,
  timeoutMs: 600000
});

const tasks = await exa.research.list({ limit: 10 });

{
  "data": [
    {
      "researchId": "task-1",
      "status": "completed",
      "instructions": "Research SpaceX valuation"
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI0LTAxLTE1VDE4OjMwOjAwWiIsImlkIjoidGFzay0yIn0="
}