API

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

usage

account.usage Get the credit balance, current-period usage, and next refill Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`credits_remaining`	`number`	Yes	—
`period`	`object`	No	—
`next_refill`	`object`	No	—
`auto_topup`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

period full type

{
  start: string,
  credits_used: number
}

next_refill full type

{
  at: string,
  credits: number
}

auto_topup full type

{
  enabled: boolean,
  credits_used_this_period: number,
  monthly_budget_credits?: number | null
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

Brand

fonts

brand.fonts List the fonts a website uses and how much of the page each covers Risk: read

await corsair.contextdev.api.brand.fonts({});

Input

Name	Type	Required	Description
`domain`	`string`	No	—
`directUrl`	`string`	No	—
`maxAgeMs`	`number`	No	—
`timeoutOpts`	`object`	No	—
`tags`	`string[]`	No	—

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`finalDOMState`	`loaded \| still-loading`	No	—
`status`	`string`	Yes	—
`domain`	`string`	Yes	—
`fonts`	`object[]`	Yes	—
`fontLinks`	`object`	No	—
`code`	`number`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

fonts full type

{
  font: string,
  uses: string[],
  fallbacks: string[],
  num_elements: number,
  num_words: number,
  percent_words: number,
  percent_elements: number
}[]

fontLinks full type

{
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

naics

brand.naics Classify a brand or business description into NAICS codes Risk: read

await corsair.contextdev.api.brand.naics({});

Input

Name	Type	Required	Description
`input`	`string`	Yes	Brand domain, title, or a description of the business
`minResults`	`number`	No	—
`maxResults`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`status`	`string`	No	—
`domain`	`string`	No	—
`type`	`string`	No	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—
`codes`	`object[]`	No	—

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

codes full type

{
  code: string,
  name: string,
  confidence: high | medium | low
}[]

prefetch

brand.prefetch Queue brand or styleguide data so a later lookup returns sooner Risk: write

await corsair.contextdev.api.brand.prefetch({});

Input

Name	Type	Required	Description
`type`	`brand \| styleguide`	Yes	—
`identifier`	`object`	Yes	—
`timeoutOpts`	`object`	No	—
`tags`	`string[]`	No	—

identifier full type

{
  domain: string
} | {
  email: string
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail
}

Output

Name	Type	Required	Description
`status`	`string`	No	—
`message`	`string`	No	—
`type`	`brand \| styleguide`	No	—
`domain`	`string`	No	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

retrieve

brand.retrieve Get a brand profile (logos, colors, socials, address, industry) by domain, name, email, ticker, URL, or card transaction Risk: read

await corsair.contextdev.api.brand.retrieve({});

Input: object

Input full type

{
  type: by_domain,
  domain: string,
  force_language?: string | null,
  maxSpeed?: boolean,
  maxAgeMs?: number,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
} | {
  type: by_name,
  name: string,
  country_gl?: string,
  force_language?: string | null,
  maxSpeed?: boolean,
  maxAgeMs?: number,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
} | {
  type: by_email,
  email: string,
  force_language?: string | null,
  maxSpeed?: boolean,
  maxAgeMs?: number,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
} | {
  type: by_ticker,
  ticker: string,
  ticker_exchange?: string,
  force_language?: string | null,
  maxSpeed?: boolean,
  maxAgeMs?: number,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
} | {
  type: by_direct_url,
  direct_url: string,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
} | {
  type: by_transaction,
  transaction_info: string,
  country_gl?: string,
  city?: string,
  mcc?: string | number,
  phone?: string | number,
  high_confidence_only?: boolean,
  force_language?: string | null,
  maxSpeed?: boolean,
  maxAgeMs?: number,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  },
  tags?: string[]
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`status`	`string`	Yes	—
`brand`	`object`	Yes	—
`code`	`number`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

brand full type

{
  domain?: string,
  title?: string,
  description?: string,
  slogan?: string,
  colors?: {
    hex?: string,
    name?: string,
    source?: site | logo
  }[],
  logos?: {
    url?: string,
    mode?: light | dark | has_opaque_background,
    colors?: {
      hex?: string,
      name?: string
    }[],
    resolution?: {
      width?: number,
      height?: number,
      aspect_ratio?: number
    },
    type?: icon | logo
  }[],
  backdrops?: {
    url?: string,
    colors?: {
      hex?: string,
      name?: string
    }[],
    resolution?: {
      width?: number,
      height?: number,
      aspect_ratio?: number
    }
  }[],
  socials?: {
    type?: string,
    url?: string
  }[],
  address?: {
    street?: string,
    city?: string,
    country?: string,
    country_code?: string,
    state_province?: string,
    state_code?: string,
    postal_code?: string
  },
  stock?: {
    ticker?: string,
    exchange?: string
  },
  employees?: {
    range?: string,
    exact?: number
  },
  is_nsfw?: boolean,
  email?: string,
  phone?: string,
  industries?: {
    eic?: {
      industry: string,
      subindustry: string
    }[]
  },
  links?: {
    careers?: string | null,
    privacy?: string | null,
    terms?: string | null,
    contact?: string | null,
    blog?: string | null,
    pricing?: string | null
  },
  primary_language?: string | null
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

search

brand.search Find up to 10 brands by name or domain Risk: read

await corsair.contextdev.api.brand.search({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`autocomplete`	`boolean`	No	—
`queryBy`	`name \| domain[]`	No	—
`typoTolerance`	`number`	No	—
`tags`	`string[]`	No	—

Output

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

results full type

{
  domain: string,
  name: string,
  logo: string
}[]

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

sic

brand.sic Classify a brand or business description into SIC codes Risk: read

await corsair.contextdev.api.brand.sic({});

Input

Name	Type	Required	Description
`input`	`string`	Yes	Brand domain, title, or a description of the business
`minResults`	`number`	No	—
`maxResults`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—
`type`	`original_sic \| latest_sec`	No	—

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`status`	`string`	No	—
`domain`	`string`	No	—
`type`	`string`	No	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—
`classification`	`original_sic \| latest_sec`	No	—
`codes`	`object[]`	No	—

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

codes full type

{
  code: string,
  name: string,
  confidence: high | medium | low,
  majorGroup?: string,
  majorGroupName?: string,
  office?: string
}[]

styleguide

brand.styleguide Extract a website’s colors, typography, spacing, shadows, and button styles Risk: read

await corsair.contextdev.api.brand.styleguide({});

Input

Name	Type	Required	Description
`domain`	`string`	No	—
`directUrl`	`string`	No	—
`maxAgeMs`	`number`	No	—
`timeoutOpts`	`object`	No	—
`colorScheme`	`light \| dark`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`finalDOMState`	`loaded \| still-loading`	No	—
`status`	`string`	No	—
`domain`	`string`	No	—
`styleguide`	`object`	No	—
`code`	`number`	No	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

styleguide full type

{
  mode: light | dark,
  colors: {
    accent: string,
    background: string,
    text: string
  },
  typography: {
    headings: {
      h1?: {
        fontFamily: string,
        fontFallbacks: string[],
        fontSize: string,
        fontWeight: number,
        lineHeight: string,
        letterSpacing: string
      },
      h2?: {
        fontFamily: string,
        fontFallbacks: string[],
        fontSize: string,
        fontWeight: number,
        lineHeight: string,
        letterSpacing: string
      },
      h3?: {
        fontFamily: string,
        fontFallbacks: string[],
        fontSize: string,
        fontWeight: number,
        lineHeight: string,
        letterSpacing: string
      },
      h4?: {
        fontFamily: string,
        fontFallbacks: string[],
        fontSize: string,
        fontWeight: number,
        lineHeight: string,
        letterSpacing: string
      }
    },
    p?: {
      fontFamily: string,
      fontFallbacks: string[],
      fontSize: string,
      fontWeight: number,
      lineHeight: string,
      letterSpacing: string
    }
  },
  elementSpacing: {
    xs: string,
    sm: string,
    md: string,
    lg: string,
    xl: string
  },
  shadows: {
    sm: string,
    md: string,
    lg: string,
    xl: string,
    inner: string
  },
  fontLinks: {
  },
  components: {
    button: {
      primary?: {
        backgroundColor: string,
        color: string,
        borderColor: string,
        borderRadius: string,
        borderWidth: string,
        borderStyle: string,
        padding: string,
        minWidth: string,
        minHeight: string,
        fontSize: string,
        fontWeight: number,
        fontFamily?: string,
        fontFallbacks?: string[],
        textDecoration: string,
        textDecorationColor?: string,
        boxShadow: string,
        css: string
      },
      secondary?: {
        backgroundColor: string,
        color: string,
        borderColor: string,
        borderRadius: string,
        borderWidth: string,
        borderStyle: string,
        padding: string,
        minWidth: string,
        minHeight: string,
        fontSize: string,
        fontWeight: number,
        fontFamily?: string,
        fontFallbacks?: string[],
        textDecoration: string,
        textDecorationColor?: string,
        boxShadow: string,
        css: string
      },
      link?: {
        backgroundColor: string,
        color: string,
        borderColor: string,
        borderRadius: string,
        borderWidth: string,
        borderStyle: string,
        padding: string,
        minWidth: string,
        minHeight: string,
        fontSize: string,
        fontWeight: number,
        fontFamily?: string,
        fontFallbacks?: string[],
        textDecoration: string,
        textDecorationColor?: string,
        boxShadow: string,
        css: string
      }
    },
    card?: {
      backgroundColor: string,
      borderColor: string,
      borderRadius: string,
      borderWidth: string,
      borderStyle: string,
      padding: string,
      boxShadow: string,
      textColor: string,
      css: string
    }
  }
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

News

search

news.search Search company news by name, domain, ticker, or ISIN, paginated by cursor Risk: read

await corsair.contextdev.api.news.search({});

Input

Name	Type	Required	Description
`searchBy`	`object`	Yes	—
`filterBy`	`object`	No	—
`sortBy`	`object`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`tags`	`string[]`	No	—

searchBy full type

{
  type: entity,
  entity: {
    type: name,
    name: string
  } | {
    type: domain,
    domain: string
  } | {
    type: ticker,
    ticker: string,
    exchange?: string
  } | {
    type: isin,
    isin: string
  }
}

filterBy full type

{
  sourceDomain?: string[],
  sourceCountry?: string[],
  articleLanguage?: string[],
  articleType?: editorial | press_release | regulatory_filing | advisory[],
  date?: {
    from?: number,
    to?: number
  }
}

sortBy full type

{
  type: relevance | newest
}

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—
`next_cursor`	`string`	No	—
`meta`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

data full type

{
  id: string,
  story_id: string,
  url: string,
  title: string,
  description?: string | null,
  language?: string | null,
  authors: string[],
  image_url?: string | null,
  published_at?: string | null,
  type: editorial | press_release | regulatory_filing | advisory,
  source: {
    name: string,
    domain: string,
    direct: boolean
  },
  match: {
    level: primary | secondary,
    confidence?: number | null
  }
}[]

meta full type

{
  count: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

People

enrich

people.enrich Find a person from an email, profile URLs, or name and return their profile with a match score Risk: read

await corsair.contextdev.api.people.enrich({});

Input

Name	Type	Required	Description
`social_urls`	`string[]`	No	—
`name`	`object`	No	—
`email`	`string`	No	—
`company`	`object`	No	—
`education`	`object[]`	No	—
`location`	`object`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

name full type

{
  first?: string,
  last?: string
}

company full type

{
  name?: string,
  domain?: string
}

education full type

{
  institution?: {
    name?: string,
    domain?: string
  },
  degree?: string,
  field_of_study?: string,
  graduation_year?: number
}[]

location full type

{
  city?: string,
  region?: string,
  country?: string
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`match`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

match full type

{
  status: candidate,
  score: number,
  person: {
    name?: {
      full?: string,
      first?: string,
      last?: string
    },
    email?: string,
    avatar_url?: string,
    bio?: string,
    location?: {
      display?: string,
      city?: string,
      region?: string,
      country?: string,
      country_code?: string
    },
    social_urls: string[],
    website_urls: string[],
    current_role?: {
      title: string,
      organization: {
        name: string,
        domain?: string
      },
      location?: string,
      description?: string,
      start_date?: {
        year: number,
        month?: number,
        day?: number
      },
      end_date?: {
        year: number,
        month?: number,
        day?: number
      },
      is_current?: boolean
    },
    current_role_status: present | none | unknown,
    experience: {
      title: string,
      organization: {
        name: string,
        domain?: string
      },
      location?: string,
      description?: string,
      start_date?: {
        year: number,
        month?: number,
        day?: number
      },
      end_date?: {
        year: number,
        month?: number,
        day?: number
      },
      is_current?: boolean
    }[],
    education: {
      institution: {
        name: string,
        domain?: string
      },
      degree?: string,
      field_of_study?: string,
      description?: string,
      start_date?: {
        year: number,
        month?: number,
        day?: number
      },
      end_date?: {
        year: number,
        month?: number,
        day?: number
      }
    }[],
    skills: string[],
    last_updated?: string,
    checked_at?: string
  }
} | {
  status: not_found,
  score: null,
  person: null
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

Web

answers

web.answers Research a task on the web and return a sourced answer in a requested JSON shape Risk: read

await corsair.contextdev.api.web.answers({});

Input

Name	Type	Required	Description
`task`	`string`	Yes	—
`mode`	`fast \| ultra`	No	—
`json_format`	`object`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

json_format full type

{
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`json_content`	`object`	Yes	—
`sources`	`string[]`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	No	—

json_content full type

{
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

crawl

web.crawl Crawl a website (up to 500 pages) and return each page as Markdown Risk: read

await corsair.contextdev.api.web.crawl({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`maxPages`	`number`	No	—
`urlRegex`	`string`	No	—
`includeLinks`	`boolean`	No	—
`includeImages`	`boolean`	No	—
`shortenBase64Images`	`boolean`	No	—
`useMainContentOnly`	`boolean`	No	—
`pdf`	`object`	No	—
`includeSelectors`	`string[]`	No	—
`excludeSelectors`	`string[]`	No	—
`country`	`string`	No	—
`maxDepth`	`number`	No	—
`followSubdomains`	`boolean`	No	—
`includeFrames`	`boolean`	No	—
`maxAgeMs`	`number`	No	—
`waitForMs`	`number`	No	—
`settleAnimations`	`boolean`	No	—
`stopAfterMs`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

pdf full type

{
  shouldParse?: boolean,
  start?: number,
  end?: number,
  ocr?: boolean
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`results`	`object[]`	Yes	—
`metadata`	`object`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

results full type

{
  markdown: string,
  metadata: {
    title: string,
    description?: string,
    language?: string,
    keywords?: string[],
    canonicalUrl?: string,
    author?: string,
    siteName?: string,
    image?: string,
    favicon?: string,
    publishedTime?: string,
    modifiedTime?: string,
    robots?: string,
    openGraph?: {
    },
    twitter?: {
    },
    alternates?: {
      href: string,
      hreflang?: string,
      type?: string,
      title?: string
    }[],
    headings?: {
      level: number,
      text: string
    }[],
    jsonLd?: {
    }[],
    additionalMeta?: {
    },
    sourceUrl: string,
    finalUrl: string,
    url: string,
    crawlDepth: number,
    statusCode: number,
    success: boolean
  }
}[]

metadata full type

{
  numUrls: number,
  maxCrawlDepth: number,
  numSucceeded: number,
  numFailed: number,
  numSkipped: number
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

extract

web.extract Extract structured data from a website using a JSON Schema Risk: read

await corsair.contextdev.api.web.extract({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`schema`	`object`	Yes	—
`instructions`	`string`	No	—
`factCheck`	`boolean`	No	—
`maxPages`	`number`	No	—
`pdf`	`object`	No	—
`actions`	`object[]`	No	—
`maxDepth`	`number`	No	—
`followSubdomains`	`boolean`	No	—
`includeFrames`	`boolean`	No	—
`maxAgeMs`	`number`	No	—
`waitForMs`	`number`	No	—
`settleAnimations`	`boolean`	No	—
`stopAfterMs`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

schema full type

{
}

pdf full type

{
  shouldParse?: boolean,
  start?: number,
  end?: number
}

actions full type

(
  {
    do: wait,
    timeMs: number
  } | {
    do: perform,
    action: string
  } | {
    do: scroll,
    direction?: up | down | left | right,
    amount?: number | viewport | max,
    container?: string,
    maxScrolls?: number
  }
)[]

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`status`	`string`	Yes	—
`url`	`string`	Yes	—
`urls_analyzed`	`string[]`	Yes	—
`data`	`object`	Yes	—
`metadata`	`object`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

data full type

{
}

metadata full type

{
  numUrls: number,
  maxCrawlDepth: number,
  numSucceeded: number,
  numFailed: number,
  numSkipped: number,
  numBlocked: number,
  actionsApplied?: {
    instruction: string,
    status: applied | failed | skipped,
    method?: string,
    targetDescription?: string,
    completionEvidence?: string,
    error?: string,
    durationMs?: number
  }[]
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

scrape

web.scrape Scrape a URL as HTML, Markdown, screenshot, images, highlights, or schema-driven JSON Risk: read

await corsair.contextdev.api.web.scrape({});

Input

Name	Type	Required	Description
`url`	`string`	Yes	—
`formats`	`object`	Yes	—
`markdownParams`	`object`	No	—
`screenshotParams`	`object`	No	—
`imageParams`	`object`	No	—
`highlightsParams`	`object`	No	—
`jsonParams`	`object`	No	—
`parseParams`	`object`	No	—
`productParams`	`object`	No	—
`sharedParams`	`object`	No	—
`maxAgeMs`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

formats full type

{
  html?: boolean,
  markdown?: boolean,
  screenshot?: boolean,
  images?: boolean,
  bytes?: boolean,
  parse?: boolean,
  highlights?: boolean,
  json?: boolean,
  product?: boolean
}

markdownParams full type

{
  includeLinks?: boolean,
  includeImages?: boolean,
  inlineImages?: placeholder | preserve
}

screenshotParams full type

{
  area?: viewport | fullPage | {
    selector: string
  } | {
    x: number,
    y: number,
    width: number,
    height: number
  },
  format?: png | jpeg | webp
}

imageParams full type

{
  enrich?: dimensions | classification | file[],
  dedupe?: none | visual
}

highlightsParams full type

{
  query: string,
  maxCharacters?: number
}

jsonParams full type

{
  schema: {
  },
  instructions?: string
}

parseParams full type

{
  type?: custom,
  rules: lazy
} | {
  type: prebuilt,
  parser: google-maps | google-play | google-play-reviews | app-store | app-store-reviews | emails | phone-numbers | links
}

productParams full type

{
  dedupeImages?: boolean
}

sharedParams full type

{
  country?: string,
  headers?: {
  },
  viewport?: {
    width?: number,
    height?: number
  },
  theme?: light | dark,
  dismissCookies?: boolean,
  dismissPopups?: boolean,
  actions?: (
    {
      type: perform,
      action: string
    } | {
      type: scroll,
      direction?: down | up | left | right,
      amount?: number | viewport | max,
      selector?: string,
      maxScrolls?: number
    } | {
      type: wait,
      milliseconds: number
    } | {
      type: waitFor,
      selector: string
    }
  )[],
  waitFor?: number | string,
  settleAnimations?: boolean,
  mainContentOnly?: boolean,
  includeSelectors?: string[],
  excludeSelectors?: string[],
  includeFrames?: boolean,
  parsers?: {
    pdf?: {
      startPage?: number,
      endPage?: number,
      ocr?: off | auto
    }
  },
  profile?: {
    type: existing,
    profileId: string
  } | {
    type: new,
    identifier: string,
    password: string
  }
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`url`	`string`	Yes	—
`html`	`object`	Yes	—
`markdown`	`object`	Yes	—
`screenshot`	`object`	Yes	—
`images`	`object`	Yes	—
`bytes`	`object`	Yes	—
`parsed`	`object`	Yes	—
`highlights`	`object`	Yes	—
`json`	`object`	Yes	—
`product`	`object`	Yes	—
`profile`	`object`	No	—
`isPartial`	`true`	No	—
`metadata`	`object`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

html full type

{
  requested: boolean,
  success?: boolean | null,
  data?: string | null,
  error_code?: string,
  message?: string
}

markdown full type

{
  requested: boolean,
  success?: boolean | null,
  data?: string | null,
  error_code?: string,
  message?: string
}

screenshot full type

{
  requested: boolean,
  success?: boolean | null,
  data?: string | null,
  error_code?: string,
  message?: string
}

images full type

{
  requested: boolean,
  success?: boolean | null,
  data?: {
    url: string,
    alt?: string | null,
    width?: number,
    height?: number,
    classification?: photography | illustration | logo | wordmark | icon | pattern | graphic | other,
    fileUrl?: string
  }[] | null,
  error_code?: string,
  message?: string
}

bytes full type

{
  requested: boolean,
  success?: boolean | null,
  data?: {
    contentType: string,
    base64: string
  } | null,
  error_code?: string,
  message?: string
}

parsed full type

{
  requested: boolean,
  success?: boolean | null,
  data?: {
  } | null,
  error_code?: string,
  message?: string,
  type: google-maps | google-play | google-play-reviews | app-store | app-store-reviews | emails | phone-numbers | links | custom
}

highlights full type

{
  requested: boolean,
  success?: boolean | null,
  data?: string[] | null,
  error_code?: string,
  message?: string
}

json full type

{
  requested: boolean,
  success?: boolean | null,
  data?: {
  } | null,
  error_code?: string,
  message?: string,
  isTruncated?: true
}

product full type

{
  requested: boolean,
  success?: boolean | null,
  data?: {
    isProductPage: boolean,
    product?: {
      name: string,
      description?: string | null,
      brand?: string | null,
      sku?: string | null,
      price?: number | null,
      regularPrice?: number | null,
      currency?: string | null,
      availability?: in_stock | out_of_stock | limited_availability | preorder | backorder | made_to_order | discontinued | null,
      category?: string | null,
      imageUrl?: string | null,
      images: string[],
      dimensions: string[],
      features: string[],
      targetAudience: string[],
      tags: string[],
      variants: {
        sku?: string | null,
        attributes: {
        },
        url?: string | null,
        images: string[]
      }[]
    } | null
  } | null,
  error_code?: string,
  message?: string
}

profile full type

{
  id: string
}

metadata full type

{
  title?: string,
  description?: string,
  language?: string,
  keywords?: string[],
  canonicalUrl?: string,
  author?: string,
  siteName?: string,
  image?: string,
  favicon?: string,
  publishedTime?: string,
  modifiedTime?: string,
  robots?: string,
  openGraph?: {
  },
  twitter?: {
  },
  alternates?: {
    href: string,
    hreflang?: string,
    type?: string,
    title?: string
  }[],
  headings?: {
    level: number,
    text: string
  }[],
  jsonLd?: {
  }[],
  additionalMeta?: {
  }
}

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

search

web.search Search the web, optionally with page Markdown or highlights per result Risk: read

await corsair.contextdev.api.web.search({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`numResults`	`number`	No	—
`includeDomains`	`string[]`	No	—
`excludeDomains`	`string[]`	No	—
`freshness`	`last_24_hours \| last_week \| last_month \| last_year`	No	—
`country`	`string`	No	—
`queryFanout`	`boolean`	No	—
`markdownOptions`	`object`	No	—
`highlightsOptions`	`object`	No	—
`descriptionMaxCharacters`	`number`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

markdownOptions full type

{
  enabled?: boolean,
  includeLinks?: boolean,
  includeImages?: boolean,
  shortenBase64Images?: boolean,
  useMainContentOnly?: boolean,
  pdf?: {
    shouldParse?: boolean,
    start?: number,
    end?: number
  },
  includeFrames?: boolean,
  maxAgeMs?: number | null,
  waitForMs?: number | null,
  timeoutOpts?: {
    milliseconds: number,
    behavior?: fail | return-partial
  }
}

highlightsOptions full type

{
  enabled?: boolean,
  maxCharacters?: number
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`partial`	`boolean`	No	—
`query`	`string`	Yes	—
`results`	`object[]`	Yes	—
`cache_metadata`	`object`	Yes	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

results full type

{
  url: string,
  title: string,
  description: string,
  relevance: high | medium | low,
  markdown: {
    finalDOMState?: loaded | still-loading,
    markdown?: string | null,
    code: SUCCESS | NOT_REQUESTED | TIMEOUT | CONTENT_TOO_LARGE | WEBSITE_ACCESS_ERROR | WEBSITE_BLOCKED | ERROR
  },
  highlights: {
    highlights?: string[] | null,
    code: SUCCESS | NOT_REQUESTED | TIMEOUT | CONTENT_TOO_LARGE | WEBSITE_ACCESS_ERROR | WEBSITE_BLOCKED | ERROR
  }
}[]

cache_metadata full type

{
  status: hit | miss | zdr,
  age_ms: number
}

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

urls

web.urls Map a domain’s URLs with titles and descriptions Risk: read

await corsair.contextdev.api.web.urls({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`headers`	`object`	No	—
`includeSubdomains`	`boolean`	No	—
`maxLinks`	`number`	No	—
`sitemapUrl`	`string`	No	—
`urlRegex`	`string`	No	—
`search`	`string`	No	—
`timeoutOpts`	`object`	No	—
`zdr`	`enabled \| disabled`	No	—
`tags`	`string[]`	No	—

headers full type

{
}

timeoutOpts full type

{
  milliseconds: number,
  behavior?: fail | return-partial
}

Output

Name	Type	Required	Description
`success`	`true`	Yes	—
`domain`	`string`	Yes	—
`urls`	`object[]`	Yes	—
`partial`	`boolean`	No	—
`key_metadata`	`object`	No	—
`request_id`	`string`	Yes	—

urls full type

{
  url: string,
  title?: string,
  description?: string,
  keywords?: string[],
  language?: string
}[]

key_metadata full type

{
  credits_consumed: number,
  credits_remaining: number
}

Overview

Plugins

Account

usage

Brand

fonts

naics

prefetch

retrieve

search

sic

styleguide

News

search

People

enrich

Web

answers

crawl

extract

scrape

search

urls

​Account

​usage

​Brand

​fonts

​naics

​prefetch

​retrieve

​search

​sic

​styleguide

​News

​search

​People

​enrich

​Web

​answers

​crawl

​extract

​scrape

​search

​urls

Account

usage

Brand

fonts

naics

prefetch

retrieve

search

sic

styleguide

News

search

People

enrich

Web

answers

crawl

extract

scrape

search

urls