Framework guide

Python integration

Use a long-lived requests Session in backend code. Pass the same idempotency identifier when a queue retries a job.

Environment

URTHEPRODUCT_BASE_URL=https://urtheproduct.com
URTHEPRODUCT_API_KEY=your-revealed-key

Complete server example

import os
import requests

session = requests.Session()
session.headers.update({
    "Authorization": "Bearer " + os.environ["URTHEPRODUCT_API_KEY"],
    "Content-Type": "application/json",
})

def generate_text(input_text: str, idempotency_key: str):
    response = session.post(
        os.environ["URTHEPRODUCT_BASE_URL"] + "/v1/text/generate",
        headers={"Idempotency-Key": idempotency_key},
        json={"input": input_text, "output_format": "markdown"},
        timeout=(10, 90),
    )
    body = response.json()
    if not response.ok:
        raise RuntimeError(f'{body["error"]["code"]}: {body["error"]["message"]}')
    return body

Production requirements

• Authenticate and authorize your application user before spending package quota.
• Validate and limit browser input before forwarding it.
• Persist the logical idempotency key in queue or request state.
• Apply timeouts and documented retry behavior.
• Return safe errors to the browser; do not forward internal input, headers, or credentials.
• Validate generated output before rendering or performing any action.