Skip to content

Align SDK with OpenAPI Spec - Add SmartCrawler Endpoint #65

@lurenss

Description

@lurenss

Align SDK with OpenAPI Spec - Add SmartCrawler Endpoint

📋 Summary

The current SDKs have discrepancies with the official OpenAPI specification. The main issues are:

  1. Endpoint Naming Mismatch: The SDK's crawl() method actually calls the /crawl endpoint, but the OpenAPI spec defines two separate endpoints: /smartcrawler and /crawl with different parameters

🔍 Current State Analysis

SDK vs OpenAPI Comparison

Feature OpenAPI Spec Current SDK Implementation Status
SmartCrawler endpoint (/smartcrawler) ✅ Defined with url, prompt, schema, depth, max_pages, sitemap, render_heavy_js ❌ Not implemented Missing
Crawl endpoint (/crawl) ✅ Defined with url, prompt, schema, depth, max_pages, sitemap, render_heavy_js, rules ✅ Implemented as crawl() Exists

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions