webcrawlerapi-js
Version:
JS client for WebcrawlerAPI
25 lines (24 loc) • 1.39 kB
TypeScript
import { CrawlRequest, Job, JobId, ScrapeRequest, ScrapeResponse, ScrapeResponseError, ScrapeId, Action, JobMarkdownResponse, AgentRunRequest, AgentRun } from "./model";
import { JobStatus, ErrorCode } from "./constants";
import { WebcrawlerApiError } from "./errors";
export { WebcrawlerApiError, JobStatus, ErrorCode };
export * from "./model";
export declare class WebcrawlerClient {
protected apiVersion: string;
protected apiKey: string;
protected basePath: string;
constructor(apiKey: string, basePath?: string, apiVersion?: string);
private getDefaultHeaders;
scrapeAsync(request: ScrapeRequest): Promise<ScrapeId>;
runAgentAsync(request: AgentRunRequest): Promise<AgentRun>;
getAgentJob(jobID: string): Promise<AgentRun>;
runAgent(request: AgentRunRequest, maxPolls?: number): Promise<AgentRun>;
getScrape(scrapeId: string): Promise<ScrapeResponse | ScrapeResponseError>;
scrape(request: ScrapeRequest, maxPolls?: number): Promise<ScrapeResponse | ScrapeResponseError>;
crawl(crawlRequest: CrawlRequest, actions?: Action | Action[]): Promise<Job>;
crawlAsync(crawlRequest: CrawlRequest, actions?: Action | Action[]): Promise<JobId>;
getJob(jobID: string): Promise<Job>;
getJobMarkdown(jobID: string): Promise<JobMarkdownResponse>;
getJobMarkdownContent(jobID: string): Promise<string>;
private sendRequest;
}