REST API
Upload tekeningen, start AI-reviews en haal resultaten programmatisch op. Integreer ClearHandoff in uw PDM, PLM of eigen workflow. Voor de volledige eindpuntreferentie, zie de API-referentie
Authenticatie
Alle API-verzoeken vereisen een Bearer-token in de Authorization-header. API-sleutels zijn gekoppeld aan uw team — elke tekening die via de API wordt geüpload of beoordeeld, behoort tot uw team. Maak API-sleutels aan en beheer ze op uw Teampagina.
Snel starten
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)Upload een tekening en start een AI-review
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"Vraag de resultaten op
curl https://www.clearhandoff.com/api/v1/drawings/DRAWING_ID/ai-review/REVIEW_ID/ \
-H "Authorization: Bearer ch_YOUR_KEY"De upload-response bevat de id van de tekening en een review_id. Bevraag dit eindpunt totdat de status verandert naar "completed" (reviews duren doorgaans 1-3 minuten). De response bevat dan bevindingen, samenvatting en aanbeveling.
Testbestand nodig? Download sample-drawing.pdf
Limieten
Limieten worden per API-sleutel toegepast. Wanneer u een limiet overschrijdt, retourneert de API 429 Too Many Requests.
| Eindpunt | Limiet |
|---|---|
| Tekening uploaden | 1,000 / uur |
| Overzicht / details / versies | 1,000 / uur |
| Review starten | 120 / uur |
| Batch-review starten | 30 / uur |
| Pen een vraag stellen | 300 / uur |
| Downloads / statuspolling | 1,000 / uur |
Voor de volledige eindpuntreferentie, zie de API-referentie | OpenAPI Schema (JSON)
