Python SDK

The official Python SDK is generated from the Bytekit OpenAPI spec, so its models and methods always match the API. Every operation ships in both synchronous and asynchronous form.

Install

pip install rapidcrawl-python

Your first scrape

from rapidcrawl_python import AuthenticatedClient
from rapidcrawl_python.api.scrape import create_scrape
from rapidcrawl_python.models.scrape_request import ScrapeRequest

client = AuthenticatedClient(
    base_url="https://api.bytekit.com",   # use https://api-stg.bytekit.com for staging
    token="sk_live_your_api_key_here",
)

body = ScrapeRequest(url="https://example.com")
response = create_scrape.sync(client=client, body=body)

if response:
    # response.formats.markdown is str | Unset — only present when "markdown" was requested
    print(response.formats.markdown)

Each operation exposes four call styles:

create_scrape.sync(...) — returns the parsed model (or None).
create_scrape.sync_detailed(...) — returns the full Response (status code, headers, body).
create_scrape.asyncio(...) — awaitable form of sync.
create_scrape.asyncio_detailed(...) — awaitable form of sync_detailed.

Async usage

import asyncio
from rapidcrawl_python import AuthenticatedClient
from rapidcrawl_python.api.screenshots import create_screenshot
from rapidcrawl_python.models.screenshot_request import ScreenshotRequest

async def main():
    client = AuthenticatedClient(
        base_url="https://api.bytekit.com",
        token="sk_live_your_api_key_here",
    )
    body = ScreenshotRequest(url="https://example.com")
    response = await create_screenshot.asyncio(client=client, body=body)
    print(response)

asyncio.run(main())

What's available

Operations are grouped by capability under rapidcrawl_python.api.*: scrape, scrape_bulk, screenshots, recordings, bulk, fetch, fetch_bulk, monitors, sitemap, and account.

See the Python SDK Reference for every module, function, and model.

Next steps

TypeScript SDK — the same API surface in TypeScript.
API Reference — the underlying REST endpoints.
Errors — error codes and retry guidance.