api.md

Parse

Types:

from context.dev.types import ParseHandleResponse

Methods:

• client.parse.handle(body, **params) -> ParseHandleResponse

Web

Types:

from context.dev.types import (
    WebExtractResponse,
    WebExtractCompetitorsResponse,
    WebExtractFontsResponse,
    WebExtractStyleguideResponse,
    WebScreenshotResponse,
    WebSearchResponse,
    WebWebCrawlMdResponse,
    WebWebScrapeHTMLResponse,
    WebWebScrapeImagesResponse,
    WebWebScrapeMdResponse,
    WebWebScrapeSitemapResponse,
)

Methods:

• client.web.extract(**params) -> WebExtractResponse
• client.web.extract_competitors(**params) -> WebExtractCompetitorsResponse
• client.web.extract_fonts(**params) -> WebExtractFontsResponse
• client.web.extract_styleguide(**params) -> WebExtractStyleguideResponse
• client.web.screenshot(**params) -> WebScreenshotResponse
• client.web.search(**params) -> WebSearchResponse
• client.web.web_crawl_md(**params) -> WebWebCrawlMdResponse
• client.web.web_scrape_html(**params) -> WebWebScrapeHTMLResponse
• client.web.web_scrape_images(**params) -> WebWebScrapeImagesResponse
• client.web.web_scrape_md(**params) -> WebWebScrapeMdResponse
• client.web.web_scrape_sitemap(**params) -> WebWebScrapeSitemapResponse

AI

Types:

from context.dev.types import AIExtractProductResponse, AIExtractProductsResponse

Methods:

• client.ai.extract_product(**params) -> AIExtractProductResponse
• client.ai.extract_products(**params) -> AIExtractProductsResponse

Brand

Types:

from context.dev.types import BrandRetrieveResponse, BrandRetrieveSimplifiedResponse

Methods:

• client.brand.retrieve(**params) -> BrandRetrieveResponse
• client.brand.retrieve_simplified(**params) -> BrandRetrieveSimplifiedResponse

Industry

Types:

from context.dev.types import IndustryRetrieveNaicsResponse, IndustryRetrieveSicResponse

Methods:

• client.industry.retrieve_naics(**params) -> IndustryRetrieveNaicsResponse
• client.industry.retrieve_sic(**params) -> IndustryRetrieveSicResponse

Utility

Types:

from context.dev.types import UtilityPrefetchResponse

Methods:

• client.utility.prefetch(**params) -> UtilityPrefetchResponse

Monitors

Types:

from context.dev.types import (
    WebhookDelivery,
    MonitorCreateResponse,
    MonitorRetrieveResponse,
    MonitorUpdateResponse,
    MonitorListResponse,
    MonitorDeleteResponse,
    MonitorGetCreditUsageResponse,
    MonitorGetLimitsResponse,
    MonitorListAccountChangesResponse,
    MonitorListAccountRunsResponse,
    MonitorListChangesResponse,
    MonitorListRunsResponse,
    MonitorRetrieveChangeResponse,
    MonitorRunResponse,
)

Methods:

• client.monitors.create(**params) -> MonitorCreateResponse
• client.monitors.retrieve(monitor_id) -> MonitorRetrieveResponse
• client.monitors.update(monitor_id, **params) -> MonitorUpdateResponse
• client.monitors.list(**params) -> MonitorListResponse
• client.monitors.delete(monitor_id) -> MonitorDeleteResponse
• client.monitors.get_credit_usage(**params) -> MonitorGetCreditUsageResponse
• client.monitors.get_limits() -> MonitorGetLimitsResponse
• client.monitors.list_account_changes(**params) -> MonitorListAccountChangesResponse
• client.monitors.list_account_runs(**params) -> MonitorListAccountRunsResponse
• client.monitors.list_changes(monitor_id, **params) -> MonitorListChangesResponse
• client.monitors.list_runs(monitor_id, **params) -> MonitorListRunsResponse
• client.monitors.retrieve_change(change_id) -> MonitorRetrieveChangeResponse
• client.monitors.run(monitor_id) -> MonitorRunResponse

Batch

Types:

from context.dev.types import (
    ErrorCount,
    Error,
    BatchRetrieveResponse,
    BatchListResponse,
    BatchCancelResponse,
    BatchGetResultsResponse,
    BatchSubmitResponse,
)

Methods:

• client.batch.retrieve(batch_id) -> BatchRetrieveResponse
• client.batch.list(**params) -> BatchListResponse
• client.batch.cancel(batch_id) -> BatchCancelResponse
• client.batch.get_results(batch_id, **params) -> BatchGetResultsResponse
• client.batch.submit(**params) -> BatchSubmitResponse