REST-API
Laden Sie Zeichnungen hoch, starten Sie KI-Prüfungen und rufen Sie Ergebnisse programmatisch ab. Integrieren Sie ClearHandoff in Ihr PDM, PLM oder Ihren eigenen Workflow. Die vollständige Endpunkt-Referenz finden Sie in der API-Referenz
Authentifizierung
Alle API-Anfragen erfordern einen Bearer-Token im Authorization-Header. API-Schlüssel sind auf Ihr Team beschränkt — alle über die API hochgeladenen oder geprüften Zeichnungen gehören zu Ihrem Team. Erstellen und verwalten Sie API-Schlüssel auf Ihrer Team-Seite.
Schnellstart
import time
import requests
API_KEY = "ch_YOUR_KEY" # Create one on your team page; use an env var in real code
# 1. Upload a drawing and start an AI review in one call
response = requests.post(
"https://www.clearhandoff.com/api/v1/drawings/",
headers={"Authorization": f"Bearer {API_KEY}"},
files={"file": open("drawing.pdf", "rb")},
data={"name": "My Drawing", "trigger_ai_review": "true"},
)
drawing = response.json()
drawing_id = drawing["id"]
review_id = drawing["review_id"]
# 2. Poll for results (reviews typically complete in 1-3 minutes)
while True:
response = requests.get(
f"https://www.clearhandoff.com/api/v1/drawings/{drawing_id}/ai-review/{review_id}/",
headers={"Authorization": f"Bearer {API_KEY}"},
)
result = response.json()
if result["status"] in ("completed", "failed"):
print(result)
break
time.sleep(5)Zeichnung hochladen und KI-Prüfung starten
curl -X POST https://www.clearhandoff.com/api/v1/drawings/ \
-H "Authorization: Bearer ch_YOUR_KEY" \
-F "file=@drawing.pdf" \
-F "name=My Drawing" \
-F "trigger_ai_review=true"Ergebnisse abfragen
curl https://www.clearhandoff.com/api/v1/drawings/DRAWING_ID/ai-review/REVIEW_ID/ \
-H "Authorization: Bearer ch_YOUR_KEY"Die Upload-Antwort enthält die id der Zeichnung und eine review_id. Fragen Sie diesen Endpunkt ab, bis der Status zu "completed" wechselt (Prüfungen dauern in der Regel 1-3 Minuten). Die Antwort enthält dann Befunde, Zusammenfassung und Empfehlung.
Testdatei benötigt? sample-drawing.pdf herunterladen
Rate Limits
Rate Limits gelten pro API-Schlüssel. Bei Überschreitung gibt die API 429 Too Many Requests zurück.
| Endpunkt | Limit |
|---|---|
| Zeichnung hochladen | 1,000 / Stunde |
| Auflisten / Detail / Versionen | 1,000 / Stunde |
| Prüfung starten | 120 / Stunde |
| Batch-Prüfung starten | 30 / Stunde |
| Pen eine Frage stellen | 300 / Stunde |
| Downloads / Status-Polling | 1,000 / Stunde |
Die vollständige Endpunkt-Referenz finden Sie in der API-Referenz | OpenAPI-Schema (JSON)
