API

Every exa.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Answer

get

answer.get Generate a direct, citation-backed answer to a natural language question Risk: read

await corsair.exa.api.answer.get({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`text`	`boolean`	No	—
`stream`	`boolean`	No	—

Output

Name	Type	Required	Description
`answer`	`string`	Yes	—
`citations`	`object[]`	No	—
`requestId`	`string`	No	—

citations full type

{
  id: string,
  url: string,
  title?: string | null,
  publishedDate?: string | null,
  author?: string | null,
  score?: number,
  text?: string,
  highlights?: string[],
  highlightScores?: number[],
  summary?: string
}[]

get

contents.get Retrieve full text, highlights, or summaries from URLs or document IDs Risk: read

await corsair.exa.api.contents.get({});

Input

Name	Type	Required	Description
`ids`	`string[]`	Yes	—
`text`	`object`	No	—
`highlights`	`object`	No	—
`summary`	`object`	No	—

text full type

{
  maxCharacters?: number,
  includeHtmlTags?: boolean
} | boolean

highlights full type

{
  numSentences?: number,
  highlightsPerUrl?: number,
  query?: string
} | boolean

summary full type

{
  query?: string
} | boolean

Output

Name	Type	Required	Description
`results`	`object[]`	Yes	—
`requestId`	`string`	No	—

results full type

{
  id: string,
  url: string,
  title?: string | null,
  publishedDate?: string | null,
  author?: string | null,
  score?: number,
  text?: string,
  highlights?: string[],
  highlightScores?: number[],
  summary?: string
}[]

Events

get

events.get Get details of a specific webset event by its ID Risk: read

await corsair.exa.api.events.get({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`eventId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`event`	Yes	—
`type`	`string`	Yes	—
`createdAt`	`string`	Yes	—
`data`	`any`	No	—

list

events.list List all events that have occurred for a webset Risk: read

await corsair.exa.api.events.list({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`hasMore`	`boolean`	No	—
`nextCursor`	`string`	No	—

data full type

{
  id: string,
  object: event,
  type: string,
  createdAt: string,
  data?: any
}[]

Imports

create

imports.create Create a new import to upload data into a webset Risk: write

await corsair.exa.api.imports.create({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`urls`	`string[]`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`import`	Yes	—
`websetId`	`string`	Yes	—
`urls`	`string[]`	No	—
`status`	`pending \| processing \| completed \| failed`	No	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	No	—

delete

imports.delete Delete an existing import [DESTRUCTIVE] Risk: destructive

await corsair.exa.api.imports.delete({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`importId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`deleted`	`boolean`	Yes	—

list

imports.list List all imports for a webset Risk: read

await corsair.exa.api.imports.list({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`hasMore`	`boolean`	No	—
`nextCursor`	`string`	No	—

data full type

{
  id: string,
  object: import,
  websetId: string,
  urls?: string[],
  status?: pending | processing | completed | failed,
  createdAt: string,
  updatedAt?: string
}[]

Monitors

create

monitors.create Create a new monitor to watch a webset for changes Risk: write

await corsair.exa.api.monitors.create({});

Input

Name	Type	Required	Description
`websetId`	`string`	Yes	—
`cadence`	`object`	Yes	—

cadence full type

{
  type: realtime | hourly | daily | weekly
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`monitor`	Yes	—
`websetId`	`string`	Yes	—
`cadence`	`object`	Yes	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	No	—

cadence full type

{
  type: realtime | hourly | daily | weekly
}

Search

findSimilar

search.findSimilar Find web pages semantically similar to a given URL Risk: read

await corsair.exa.api.search.findSimilar({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`numResults`	`number`	No	—
`includeDomains`	`string[]`	No	—
`excludeDomains`	`string[]`	No	—
`startCrawlDate`	`string`	No	—
`endCrawlDate`	`string`	No	—
`startPublishedDate`	`string`	No	—
`endPublishedDate`	`string`	No	—
`excludeSourceDomain`	`boolean`	No	—
`category`	`string`	No	—
`contents`	`object`	No	—

contents full type

{
  text?: {
    maxCharacters?: number,
    includeHtmlTags?: boolean
  } | boolean,
  highlights?: {
    numSentences?: number,
    highlightsPerUrl?: number,
    query?: string
  } | boolean,
  summary?: {
    query?: string
  } | boolean
}

Output

Name	Type	Required	Description
`results`	`object[]`	Yes	—
`requestId`	`string`	No	—

results full type

{
  id: string,
  url: string,
  title?: string | null,
  publishedDate?: string | null,
  author?: string | null,
  score?: number,
  text?: string,
  highlights?: string[],
  highlightScores?: number[],
  summary?: string
}[]

search

search.search Search the web using neural or keyword search Risk: read

await corsair.exa.api.search.search({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`numResults`	`number`	No	—
`includeDomains`	`string[]`	No	—
`excludeDomains`	`string[]`	No	—
`startCrawlDate`	`string`	No	—
`endCrawlDate`	`string`	No	—
`startPublishedDate`	`string`	No	—
`endPublishedDate`	`string`	No	—
`useAutoprompt`	`boolean`	No	—
`type`	`keyword \| neural \| auto`	No	—
`category`	`string`	No	—
`contents`	`object`	No	—

contents full type

{
  text?: {
    maxCharacters?: number,
    includeHtmlTags?: boolean
  } | boolean,
  highlights?: {
    numSentences?: number,
    highlightsPerUrl?: number,
    query?: string
  } | boolean,
  summary?: {
    query?: string
  } | boolean
}

Output

Name	Type	Required	Description
`results`	`object[]`	Yes	—
`autopromptString`	`string`	No	—
`requestId`	`string`	No	—

results full type

{
  id: string,
  url: string,
  title?: string | null,
  publishedDate?: string | null,
  author?: string | null,
  score?: number,
  text?: string,
  highlights?: string[],
  highlightScores?: number[],
  summary?: string
}[]

Webhooks Api

list

webhooksApi.list List all webhooks configured for websets Risk: read

await corsair.exa.api.webhooksApi.list({});

Input

Name	Type	Required	Description
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`hasMore`	`boolean`	No	—
`nextCursor`	`string`	No	—

data full type

{
  id: string,
  object: webhook,
  url: string,
  events?: string[],
  status?: active | inactive,
  createdAt: string,
  updatedAt?: string
}[]

Websets

create

websets.create Create a new webset with search, import, and enrichment setup Risk: write

await corsair.exa.api.websets.create({});

Input

Name	Type	Required	Description
`searches`	`object[]`	No	—
`enrichments`	`object[]`	No	—
`externalId`	`string`	No	—

searches full type

{
  query: string,
  count?: number,
  entity?: {
    type?: company | person | article | research paper | repository | event | product | video | job | podcast
  },
  criteria?: {
    description: string,
    successRate?: string
  }[]
}[]

enrichments full type

{
  description: string,
  format?: text | date | number | options | boolean,
  options?: string[]
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`webset`	Yes	—
`status`	`idle \| running \| paused \| done`	Yes	—
`externalId`	`string`	No	—
`searches`	`object[]`	No	—
`enrichments`	`object[]`	No	—
`imports`	`object[]`	No	—
`monitors`	`object[]`	No	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—

searches full type

{
  query: string,
  count?: number,
  entity?: {
    type?: company | person | article | research paper | repository | event | product | video | job | podcast
  },
  criteria?: {
    description: string,
    successRate?: string
  }[]
}[]

enrichments full type

{
  id: string,
  description: string,
  format: text | date | number | options | boolean,
  options?: string[],
  createdAt: string,
  updatedAt: string
}[]

imports full type

{
  id: string,
  object: import,
  websetId: string,
  urls?: string[],
  status?: pending | processing | completed | failed,
  createdAt: string,
  updatedAt?: string
}[]

monitors full type

{
  id: string,
  object: monitor,
  websetId: string,
  cadence: {
    type: realtime | hourly | daily | weekly
  },
  createdAt: string,
  updatedAt?: string
}[]

delete

websets.delete Delete a webset [DESTRUCTIVE] Risk: destructive

await corsair.exa.api.websets.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`webset`	Yes	—
`deleted`	`boolean`	Yes	—

get

websets.get Get details of a specific webset by its ID Risk: read

await corsair.exa.api.websets.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`webset`	Yes	—
`status`	`idle \| running \| paused \| done`	Yes	—
`externalId`	`string`	No	—
`searches`	`object[]`	No	—
`enrichments`	`object[]`	No	—
`imports`	`object[]`	No	—
`monitors`	`object[]`	No	—
`createdAt`	`string`	Yes	—
`updatedAt`	`string`	Yes	—

searches full type

{
  query: string,
  count?: number,
  entity?: {
    type?: company | person | article | research paper | repository | event | product | video | job | podcast
  },
  criteria?: {
    description: string,
    successRate?: string
  }[]
}[]

enrichments full type

{
  id: string,
  description: string,
  format: text | date | number | options | boolean,
  options?: string[],
  createdAt: string,
  updatedAt: string
}[]

imports full type

{
  id: string,
  object: import,
  websetId: string,
  urls?: string[],
  status?: pending | processing | completed | failed,
  createdAt: string,
  updatedAt?: string
}[]

monitors full type

{
  id: string,
  object: monitor,
  websetId: string,
  cadence: {
    type: realtime | hourly | daily | weekly
  },
  createdAt: string,
  updatedAt?: string
}[]

Overview

Plugins

Answer

get

Contents

get

Events

get

list

Imports

create

delete

list

Monitors

create

Search

findSimilar

search

Webhooks Api

list

Websets

create

delete

get

Overview

Plugins

​Answer

​get

​Contents

​get

​Events

​get

​list

​Imports

​create

​delete

​list

​Monitors

​create

​Search

​findSimilar

​search

​Webhooks Api

​list

​Websets

​create

​delete

​get

Answer

get

Contents

get

Events

get

list

Imports

create

delete

list

Monitors

create

Search

findSimilar

search

Webhooks Api

list

Websets

create

delete

get