Rayon Python SDK

Generate Shape headers or form telemetry and read account usage. Keep your API key server-side. Your integration owns its HTTP client or browser and target session.

Quickstart · SDK guide · All SDKs

Install

python -m pip install 'rayon-sdk-py>=1.1.4,<2'

Check usage, then generate

Set RAYON_API_KEY. Prepare shape.json using the input guide: source-page URL, complete ordered script sources, a profile object and the exact target request. Include browser measurements or JavaScript-visible cookies only when your flow requires them.

import json
import os
from pathlib import Path
from rayon_sdk_py import Client

with Client(os.environ["RAYON_API_KEY"]) as client:
    usage = client.usage()  # Free; no generation quota used.
    print(usage)
    shape = json.loads(Path("shape.json").read_text(encoding="utf-8"))
    result = client.generate(shape)
    # Apply result.headers using your existing target client/session.
    # Reuse client here for further requests with their current inputs.
    print(result.request_id)

Apply the entire returned header map unchanged, including optional a0, to that exact request. Keep required application headers, authentication and session state in your target client. RayonAPI does not download scripts, send the target request or return target cookies. Inspect the target response to establish acceptance.

Form telemetry

For observed URL-encoded form telemetry, use mode: "form" and supply the exact application body before telemetry insertion. The result has form_fields and form_body, without generated headers. Prepend form_body once to the original body, preserving its bytes, duplicate fields and encoding. See Form payload integration for complete examples.

Client options and errors

Requires Python 3.10+. Use AsyncClient with async with, await client.usage() and await client.generate(shape) in async applications. Set timeout=45 in the constructor to set the API timeout. Errors inherit RayonError: ValidationError, TransportError, HTTPError and InvalidResponseError. Available metadata includes status_code, request_id, code, retry_after, reason, action, domain, field, billing_status and retryable.

The default API URL is https://api.rayonapi.com; default timeout is 45 seconds. Keep one client open across calls. Python and JavaScript SDK 1.1.4 reuse material in both modes while generating fresh telemetry for each request. Read the material and recovery policy for cache scope, limits and the single confirmed uncharged material recovery.

Check request history before resubmitting after a timeout or uncertain billing outcome. See errors and retry guidance, request fields and browser/session inputs. The Python download helper is optional.

Support · Releases · MIT license