Files
sdk/docs/ScrapeApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

3.1 KiB

ScrapeApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
websearchWebScrape POST /v1/websearch/v1/scrape Scrape a URL to markdown (Firecrawl response shape)
websearchWebScrapeBare POST /v1/websearch/scrape Scrape a URL to markdown (bare alias of /v1/websearch/v1/scrape)

websearchWebScrape

WebsearchScrapeResponse websearchWebScrape(websearchScrapeRequest)

Scrape a URL to markdown (Firecrawl response shape)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ScrapeApi()
val websearchScrapeRequest : WebsearchScrapeRequest =  // WebsearchScrapeRequest | 
try {
    val result : WebsearchScrapeResponse = apiInstance.websearchWebScrape(websearchScrapeRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ScrapeApi#websearchWebScrape")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ScrapeApi#websearchWebScrape")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websearchScrapeRequest WebsearchScrapeRequest

Return type

WebsearchScrapeResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

websearchWebScrapeBare

WebsearchScrapeResponse websearchWebScrapeBare(websearchScrapeRequest)

Scrape a URL to markdown (bare alias of /v1/websearch/v1/scrape)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ScrapeApi()
val websearchScrapeRequest : WebsearchScrapeRequest =  // WebsearchScrapeRequest | 
try {
    val result : WebsearchScrapeResponse = apiInstance.websearchWebScrapeBare(websearchScrapeRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ScrapeApi#websearchWebScrapeBare")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ScrapeApi#websearchWebScrapeBare")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
websearchScrapeRequest WebsearchScrapeRequest

Return type

WebsearchScrapeResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json