Python

Das offizielle Python-SDK von CaptureKit mit einer typisierten Methode pro Endpunkt und einem generischen request() für alles andere.

VoraussetzungenAnkerlink kopieren

• Python 3.11+

InstallationAnkerlink kopieren

pip install capturekitdev

API-Schlüssel erhaltenAnkerlink kopieren

Kopieren Sie Ihren API-Schlüssel aus dem CaptureKit-Dashboard und legen Sie ihn in der Umgebungsvariable CAPTUREKIT_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

SchnellstartAnkerlink kopieren

import os

from capturekit import CaptureKitClient

with CaptureKitClient(os.environ["CAPTUREKIT_API_KEY"]) as client:
    response = client.content(url="https://example.com")
    print(response.data)

Asynchrone JobsAnkerlink kopieren

Jeder Aufruf akzeptiert is_async, nützlich jenseits des Serverlimits von 60 Sekunden. Die Antwort ist dann eine job_id, und das SDK kann auf das Ende des Jobs warten.

submitted = client.content(url="https://example.com", is_async=True)
job = client.wait_for_job(
    submitted.data["job_id"],
    on_progress=lambda j: print(j["status"], j.get("progress")),
)
print(job.data)

FehlerAnkerlink kopieren

Eine Antwort außerhalb von 2xx löst einen API-Fehler mit Status und Meldung aus. Die vollständige Liste finden Sie unter Statuscodes.

from capturekit import CaptureKitAPIError

try:
    client.content(url="https://example.com")
except CaptureKitAPIError as error:
    print(error.status, error, error.response_body)

WiederholungenAnkerlink kopieren

Anfragen werden bis zu 3-mal wiederholt nach einem Netzwerkfehler, einem 408, 500, 502, 503 oder 504 oder einem Ratenlimit des Tarifs. Kontingentfehler pro Schlüssel und clientseitige Timeouts werden nicht wiederholt. Die Wartezeit beginnt bei 1 Sekunde und wächst pro Wiederholung um das 1,5-Fache; ein Retry-After-Header hat Vorrang.

client = CaptureKitClient(max_retries=5, retry_delay=0.5)

# or for one request
client.content(url="https://example.com", request_options=RequestOptions(max_retries=0))

Batch-AnfragenAnkerlink kopieren

Führen Sie viele Aufrufe gleichzeitig aus, standardmäßig 10. Ein Fehler stoppt die anderen nicht.

inputs = ["https://example.com", "https://www.capturekit.dev", "https://github.com"]
results = client.batch(inputs, lambda url: client.content(url=url), concurrency=5)

for result in results:
    if result.ok:
        print(result.value.data)
    else:
        print(inputs[result.index], result.error)

Beliebiger EndpunktAnkerlink kopieren

request() erreicht jeden Pfad, auch Endpunkte, die nach Ihrer SDK-Version erschienen sind.

response = client.request("GET", "/v1/usage")

Häufige FehlerAnkerlink kopieren

• Den API-Schlüssel in Frontend-Code einbauen. Jeder könnte ihn lesen. Rufen Sie die API von Ihrem Server auf.
• Jeden 401 als falschen Schlüssel behandeln. Ein 401 kann auch ein Ratenlimit sein: Lesen Sie die Meldung. Das SDK wiederholt Tarif-Ratenlimits automatisch.
• Einen 402 wiederholen. Es sind keine Credits oder Kontingente mehr übrig, eine Wiederholung kann also nicht gelingen. Siehe Credits.
• Auf lange Anfragen warten. Nutzen Sie ab 60 Sekunden den asynchronen Modus wie oben gezeigt, statt das Timeout zu erhöhen. Siehe Timeout.

LinksAnkerlink kopieren

• Paket: capturekitdev
• Quellcode: github.com/capturekitdev/capturekit-python
• API-Referenz