API

Every search1api.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.

Account

health

account.health Check whether the Search1API API is serving traffic Risk: read

await corsair.search1api.api.account.health({});

Input: empty object Output

Name	Type	Required	Description
`status`	`string`	Yes	—
`timestamp`	`string`	No	—
`version`	`string`	No	—

usage

account.usage Get the remaining credit balance Risk: read

await corsair.search1api.api.account.usage({});

Input

Name	Type	Required	Description
`period`	`day \| week \| month \| year`	No	—

Output

Name	Type	Required	Description
`usage`	`number`	Yes	—
`user_id`	`string`	No	—
`credential_type`	`api_key \| oauth`	Yes	—
`client_id`	`string`	No	—

Content

crawl

content.crawl Crawl a URL and return its readable content Risk: read

await corsair.search1api.api.content.crawl({ url: 'https://example.com/docs' });

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`enableFallback`	`boolean`	No	—

Output

Name	Type	Required	Description
`crawlParameters`	`object`	Yes	—
`results`	`object`	Yes	—

crawlParameters full type

{
  url: string
}

results full type

{
  title: string,
  link: string,
  content: string,
  metadata?: {
  }
}

crawlBatch

content.crawlBatch Crawl many URLs in a single request Risk: read

await corsair.search1api.api.content.crawlBatch({});

Input: object[]

Input full type

{
  url: string,
  enableFallback?: boolean
}[]

Output: object[]

Output full type

{
  crawlParameters: {
    url: string
  },
  results: {
    title: string,
    link: string,
    content: string,
    metadata?: {
    }
  }
}[]

extract

content.extract Extract structured data from a page with a prompt Risk: read

await corsair.search1api.api.content.extract({ url: 'https://example.com/pricing', prompt: 'List the pricing tiers' });

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`prompt`	`string`	No	—
`response_format`	`object`	No	—

response_format full type

{
}

Output

Name	Type	Required	Description
`success`	`true`	Yes	—
`extractParameters`	`object`	Yes	—
`results`	`any`	Yes	—

extractParameters full type

{
  url: string
}

screenshot

content.screenshot Render a page as a PNG, JPEG, or WebP image Risk: read

await corsair.search1api.api.content.screenshot({
	url: 'https://example.com',
	full_page: true,
	viewport: { width: 1440, height: 900 },
});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`format`	`png \| jpeg \| webp`	No	—
`full_page`	`boolean`	No	—
`viewport`	`object`	No	—
`wait_until`	`domcontentloaded \| load \| networkidle`	No	—
`wait_for_selector`	`string`	No	—
`selector`	`string`	No	—
`delay_ms`	`number`	No	—
`timeout_ms`	`number`	No	—
`quality`	`number`	No	—
`omit_background`	`boolean`	No	—
`color_scheme`	`light \| dark`	No	—
`animations`	`disabled \| allow`	No	—

viewport full type

{
  width?: number,
  height?: number,
  device_scale_factor?: number
}

Output

Name	Type	Required	Description
`contentType`	`string`	Yes	—
`base64`	`string`	Yes	—
`sizeBytes`	`number`	Yes	—

sitemap

content.sitemap Extract a site’s URLs from its sitemap Risk: read

await corsair.search1api.api.content.sitemap({ url: 'https://example.com', type: 'sitemap' });

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`type`	`sitemap \| all`	No	—

Output

Name	Type	Required	Description
`links`	`string[]`	Yes	—

Deepcrawl

start

deepcrawl.start Start an asynchronous whole-site crawl Risk: write

await corsair.search1api.api.deepcrawl.start({ url: 'https://example.com', type: 'sitemap' });

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`type`	`sitemap \| all`	No	—

Output

Name	Type	Required	Description
`taskId`	`string`	Yes	—
`status`	`queued`	Yes	—

status

deepcrawl.status Check a deepcrawl task’s status and result archive Risk: read

await corsair.search1api.api.deepcrawl.status({});

Input

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

Output

Name	Type	Required	Description
`taskId`	`string`	Yes	—
`status`	`queued \| waiting \| processing \| completed \| failed \| not_found`	Yes	—
`success`	`boolean`	No	—
`message`	`string`	No	—
`error`	`string`	No	—
`r2Key`	`string`	No	—
`zipUrl`	`string`	No	—

Web

ask

web.ask Agentic search that picks engines and reranks results automatically Risk: read

await corsair.search1api.api.web.ask({ query: 'what shipped in AI this week?' });

Input

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

Output

Name	Type	Required	Description
`query`	`string`	Yes	—
`intent`	`object`	Yes	—
`results`	`object[]`	Yes	—
`errors`	`object[]`	Yes	—

intent full type

{
  search_query: string,
  sources: string[],
  time_range?: day | week | month | year | | null
}

results full type

{
  title: string,
  link: string,
  snippet: string,
  published_date?: string,
  source: string,
  relevance: number
}[]

errors full type

{
  source: string,
  message: string
}[]

feedback

web.feedback Report a Search1API problem or feature request from an agent run Risk: write

await corsair.search1api.api.web.feedback({ message: 'POST /crawl returned empty content for example.com/docs', category: 'bug', request_id: 'req_8f3a' });

Input

Name	Type	Required	Description
`message`	`string`	Yes	—
`intent`	`string`	No	—
`category`	`bug \| feature_request \| docs \| other`	No	—
`request_id`	`string`	No	—
`agent`	`object`	No	—

agent full type

{
  name?: string,
  model?: string
}

Output

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

news

web.news Search recent news across six sources Risk: read

await corsair.search1api.api.web.news({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`search_service`	`google \| bing \| duckduckgo \| yahoo \| hackernews \| reuters \|`	No	—
`max_results`	`number`	No	—
`crawl_results`	`number`	No	—
`image`	`boolean`	No	—
`include_sites`	`string[]`	No	—
`exclude_sites`	`string[]`	No	—
`language`	`string`	No	—
`time_range`	`day \| week \| month \| year \|`	No	—

Output

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

searchParameters full type

{
  query: string,
  search_service?: google | bing | duckduckgo | yahoo | hackernews | reuters | ,
  max_results?: number,
  crawl_results?: number,
  image?: boolean,
  include_sites?: string[],
  exclude_sites?: string[],
  language?: string,
  time_range?: day | week | month | year |
}

results full type

{
  title: string,
  link: string,
  snippet: string,
  content?: string,
  published_date?: string,
  metadata?: {
    kind?: repo | issue | pr | discussion,
    stars?: number,
    language?: string,
    num_comments?: number,
    story_url?: string,
    points?: number
  }
}[]

newsBatch

web.newsBatch Run many news searches in a single request Risk: read

await corsair.search1api.api.web.newsBatch({});

Input: object[]

Input full type

{
  query: string,
  search_service?: google | bing | duckduckgo | yahoo | hackernews | reuters | ,
  max_results?: number,
  crawl_results?: number,
  image?: boolean,
  include_sites?: string[],
  exclude_sites?: string[],
  language?: string,
  time_range?: day | week | month | year |
}[]

Output

Name	Type	Required	Description
`results`	`object[]`	Yes	—
`summary`	`object`	Yes	—

results full type

{
  success: boolean,
  data?: {
    searchParameters: {
      query: string,
      search_service?: google | bing | duckduckgo | yahoo | hackernews | reuters | ,
      max_results?: number,
      crawl_results?: number,
      image?: boolean,
      include_sites?: string[],
      exclude_sites?: string[],
      language?: string,
      time_range?: day | week | month | year |
    },
    results: {
      title: string,
      link: string,
      snippet: string,
      content?: string,
      published_date?: string,
      metadata?: {
        kind?: repo | issue | pr | discussion,
        stars?: number,
        language?: string,
        num_comments?: number,
        story_url?: string,
        points?: number
      }
    }[],
    images?: string[]
  },
  error?: {
    message?: string,
    statusCode?: number
  },
  cost: number
}[]

summary full type

{
  total: number,
  successful: number,
  failed: number,
  totalCost: number
}

search

web.search Search the web across 19 engines, with optional crawling Risk: read

await corsair.search1api.api.web.search({ query: 'open source integration layer', search_service: 'duckduckgo', max_results: 10 });

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`search_service`	`360 \| google \| bing \| bingcn \| duckduckgo \| yahoo \| yandex \| youtube \| x \| reddit \| github \| arxiv \| wechat \| bilibili \| imdb \| wikipedia \| grokipedia \| baidu \| quark \|`	No	—
`max_results`	`number`	No	—
`page`	`number`	No	—
`crawl_results`	`number`	No	—
`image`	`boolean`	No	—
`include_sites`	`string[]`	No	—
`exclude_sites`	`string[]`	No	—
`language`	`string`	No	—
`time_range`	`day \| week \| month \| year \|`	No	—

Output

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

searchParameters full type

{
  query: string,
  search_service?: 360 | google | bing | bingcn | duckduckgo | yahoo | yandex | youtube | x | reddit | github | arxiv | wechat | bilibili | imdb | wikipedia | grokipedia | baidu | quark | ,
  max_results?: number,
  page?: number,
  crawl_results?: number,
  image?: boolean,
  include_sites?: string[],
  exclude_sites?: string[],
  language?: string,
  time_range?: day | week | month | year |
}

results full type

{
  title: string,
  link: string,
  snippet: string,
  content?: string,
  published_date?: string,
  metadata?: {
    kind?: repo | issue | pr | discussion,
    stars?: number,
    language?: string,
    num_comments?: number,
    story_url?: string,
    points?: number
  }
}[]

searchBatch

web.searchBatch Run many web searches in a single request Risk: read

await corsair.search1api.api.web.searchBatch({});

Input: object[]

Input full type

{
  query: string,
  search_service?: 360 | google | bing | bingcn | duckduckgo | yahoo | yandex | youtube | x | reddit | github | arxiv | wechat | bilibili | imdb | wikipedia | grokipedia | baidu | quark | ,
  max_results?: number,
  page?: number,
  crawl_results?: number,
  image?: boolean,
  include_sites?: string[],
  exclude_sites?: string[],
  language?: string,
  time_range?: day | week | month | year |
}[]

Output

Name	Type	Required	Description
`results`	`object[]`	Yes	—
`summary`	`object`	Yes	—

results full type

{
  success: boolean,
  data?: {
    searchParameters: {
      query: string,
      search_service?: 360 | google | bing | bingcn | duckduckgo | yahoo | yandex | youtube | x | reddit | github | arxiv | wechat | bilibili | imdb | wikipedia | grokipedia | baidu | quark | ,
      max_results?: number,
      page?: number,
      crawl_results?: number,
      image?: boolean,
      include_sites?: string[],
      exclude_sites?: string[],
      language?: string,
      time_range?: day | week | month | year |
    },
    results: {
      title: string,
      link: string,
      snippet: string,
      content?: string,
      published_date?: string,
      metadata?: {
        kind?: repo | issue | pr | discussion,
        stars?: number,
        language?: string,
        num_comments?: number,
        story_url?: string,
        points?: number
      }
    }[],
    images?: string[]
  },
  error?: {
    message?: string,
    statusCode?: number
  },
  cost: number
}[]

summary full type

{
  total: number,
  successful: number,
  failed: number,
  totalCost: number
}

web.trending Get trending topics from GitHub or Hacker News Risk: read

await corsair.search1api.api.web.trending({ search_service: 'github', max_results: 10 });

Input

Name	Type	Required	Description
`search_service`	`string`	Yes	—
`max_results`	`number`	No	—

Output

Name	Type	Required	Description
`trendingParameters`	`object`	Yes	—
`results`	`object[]`	Yes	—

trendingParameters full type

{
  search_service: string,
  max_results?: number
}

results full type

{
  title: string,
  url: string,
  description?: string | null
}[]

Overview

Plugins

Account

health

usage

Content

crawl

crawlBatch

extract

screenshot

sitemap

Deepcrawl

start

status

Web

ask

feedback

news

newsBatch

search

searchBatch

​Account

​health

​usage

​Content

​crawl

​crawlBatch

​extract

​screenshot

​sitemap

​Deepcrawl

​start

​status

​Web

​ask

​feedback

​news

​newsBatch

​search

​searchBatch

​trending

Account

health

usage

Content

crawl

crawlBatch

extract

screenshot

sitemap

Deepcrawl

start

status

Web

ask

feedback

news

newsBatch

search

searchBatch

trending