@hyperbrowser/sdk/dist/tools/schema.d.ts

Node SDK for Hyperbrowser API

export declare const SCRAPE_SCHEMA: {
    type: "object";
    properties: {
        url: {
            type: string;
            description: string;
        };
        scrapeOptions: {
            type: string;
            description: string;
            properties: {
                formats: {
                    type: string;
                    description: string;
                    items: {
                        type: string;
                        enum: ("markdown" | "screenshot")[];
                    };
                };
                includeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                excludeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                onlyMainContent: {
                    type: string;
                    description: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
    };
    required: string[];
    additionalProperties: boolean;
};
export declare const SCREENSHOT_SCHEMA: {
    type: "object";
    properties: {
        url: {
            type: string;
            description: string;
        };
        scrapeOptions: {
            type: string;
            description: string;
            properties: {
                formats: {
                    type: string;
                    description: string;
                    items: {
                        type: string;
                        enum: ("markdown" | "screenshot")[];
                    };
                };
                includeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                excludeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                onlyMainContent: {
                    type: string;
                    description: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
    };
    required: string[];
    additionalProperties: boolean;
};
export declare const CRAWL_SCHEMA: {
    type: "object";
    properties: {
        url: {
            type: string;
            description: string;
        };
        maxPages: {
            type: string;
            description: string;
        };
        followLinks: {
            type: string;
            description: string;
        };
        ignoreSitemap: {
            type: string;
            description: string;
        };
        excludePatterns: {
            type: string;
            items: {
                type: string;
            };
            description: string;
        };
        includePatterns: {
            type: string;
            items: {
                type: string;
            };
            description: string;
        };
        scrapeOptions: {
            type: string;
            description: string;
            properties: {
                formats: {
                    type: string;
                    description: string;
                    items: {
                        type: string;
                        enum: ("markdown" | "screenshot")[];
                    };
                };
                includeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                excludeTags: {
                    type: string;
                    items: {
                        type: string;
                    };
                    description: string;
                };
                onlyMainContent: {
                    type: string;
                    description: string;
                };
            };
            required: string[];
            additionalProperties: boolean;
        };
    };
    required: string[];
    additionalProperties: boolean;
};
export declare const EXTRACT_SCHEMA: {
    type: "object";
    properties: {
        urls: {
            type: string;
            items: {
                type: string;
            };
            description: string;
        };
        prompt: {
            type: string;
            description: string;
        };
        schema: {
            type: string;
            description: string;
        };
        maxLinks: {
            type: string;
            description: string;
        };
    };
    required: string[];
    additionalProperties: boolean;
};
export declare const BROWSER_USE_SCHEMA: {
    type: "object";
    properties: {
        task: {
            type: string;
            description: string;
        };
        llm: {
            description: string;
            type: string;
            enum: string[];
            default: string;
        };
        plannerLlm: {
            description: string;
            type: string;
            enum: string[];
            default: string;
        };
        pageExtractionLlm: {
            description: string;
            type: string;
            enum: string[];
            default: string;
        };
        keepBrowserOpen: {
            type: string;
            description: string;
        };
    };
    required: string[];
    additionalProperties: boolean;
};