Skip to content
SDKsPython SDK

Python SDK

The renderkit-sdk package (imported as renderkit) gives Python a thin, typed client over the REST API. Requires Python 3.9+.

Install

pip install renderkit-sdk

Initialize

renderkit
import os
from renderkit import RenderKit

rk = RenderKit(os.environ["RK_KEY"])

Example

render.py
from renderkit import RenderKit

rk = RenderKit(os.environ["RK_KEY"])

doc = rk.extract(
    url="https://paulgraham.com/greatwork.html",
    format="markdown",
    chunk=True,
    chunk_max_tokens=512,
)

print(doc["meta"]["word_count"])
for chunk in doc["meta"]["chunks"]:
    embed(chunk)  # your vector pipeline

Saving a screenshot

save.py
import requests

shot = rk.screenshot(url="https://stripe.com", full_page=True)
img = requests.get(shot["url"]).content
open("stripe.png", "wb").write(img)

Dict responses

Methods return the data object as a plain dict. Access fields with doc["url"], doc["content"], doc["meta"]. Errors raise RenderKitError with .code and .request_id.