ה־API של Leveredge

בקשה ראשונה בשלושה צעדים

1. מבקשים מפתח API ומגדירים אותו כמשתנה סביבה בשם LEVEREDGE_API_KEY בסביבה שמריצה את הקוד.
2. שומרים את הדוגמה בקובץ request.json ומחליפים את הכתובת בדף ציבורי אמיתי שרוצים לבדוק.
3. מריצים את הבקשה, שומרים את ה־id ובודקים את התוצאה באמצעות בקשת קריאה.

{
  "url": "https://your-business.co.il/landing",
  "premium": false,
  "wait": false
}

curl --fail-with-body --silent --show-error \
  --request POST 'https://www.leveredge.ai/api/v1/audits' \
  --header "Authorization: Bearer $LEVEREDGE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json

כל יצירת דוח משתמשת ביחידה מהמכסה. המפתח שייך לחשבון שלכם; שומרים אותו בשרת או בסביבת הסוכן, ולא בקוד שרץ בדפדפן.

מחברים Claude, Codex או סוכן אחר

סוכן עם גישה להרצת קוד ולבקשות HTTPS יכול לקרוא ל־API ישירות. מגדירים את המפתח בסביבת הריצה שלו ומוסיפים את ההנחיות הבאות. אין צורך להדביק את המפתח בתוך השיחה.

השתמש ב־Leveredge לניתוח הדף הציבורי שאבקש לבדוק.
תיעוד: https://www.leveredge.ai/he/api-docs
כתובת ה־API: https://www.leveredge.ai/api/v1
קרא את המפתח ממשתנה הסביבה LEVEREDGE_API_KEY. אל תדפיס אותו ואל תכתוב אותו לקוד או ליומן.
צור דוח אחד בלבד באמצעות POST /audits עם url, premium:false ו־wait:false. בקש הדמיה רק אם ביקשתי אותה.
שמור את id שהתקבל. בדוק התקדמות באמצעות GET /audits/{id} עם אותו מפתח, כל 10 שניות, עד 5 דקות.
אם status הוא done, סכם בעברית את הציון, הממצאים ותיקוני העדיפות וצרף את share_url.
אם status הוא error, הצג את error_kind ואת retryable ועצור. גם אחרי שגיאת רשת, אל תיצור דוח נוסף אוטומטית.
אם זמן ההמתנה הסתיים, שמור את id כדי שאפשר יהיה להמשיך לבדוק אותו בהמשך.
אל תשנה את האתר ואל תפרסם בו שינויים כחלק מבקשת הניתוח.

לאחר ההגדרה אפשר לבקש: ״בדוק באמצעות Leveredge את דף הנחיתה שלי בכתובת [כתובת האתר], בלי הדמיה, והצג את שלושת התיקונים החשובים ביותר.״

יצירת דוח

POST /api/v1/audits · כותרת האימות בכל בקשה היא Authorization: Bearer cvk_....

מומלץ לסוכנים ולאוטומציות להשתמש ב־wait:false. יצירת הדמיה מסתיימת תמיד ברקע. תשובת 202 אומרת שהדוח נוצר ונמצא בעיבוד, ולא שהניתוח כבר הושלם.

{
  "id": "audit-id",
  "status": "processing",
  "share_url": "https://www.leveredge.ai/r/audit-id",
  "poll_url": "https://www.leveredge.ai/api/v1/audits/audit-id"
}

קבלת הדוח וההתקדמות

GET /api/v1/audits/:id עם אותו מפתח שיצר את הדוח. הקריאה אינה יוצרת דוח נוסף ואינה צורכת יחידה נוספת מהמכסה.

curl --fail-with-body --silent --show-error \
  'https://www.leveredge.ai/api/v1/audits/REPLACE_WITH_AUDIT_ID' \
  --header "Authorization: Bearer $LEVEREDGE_API_KEY"

{
  "id": "audit-id",
  "status": "done",
  "mockup": null,
  "score": 46,
  "analysis": {
    "overall_score": 46,
    "roast_summary": "...",
    "issues": [],
    "priority_fixes": []
  },
  "before_url": "https://www.leveredge.ai/img/before.webp",
  "mobile_url": "https://www.leveredge.ai/img/mobile.webp",
  "after_url": null,
  "share_url": "https://www.leveredge.ai/r/audit-id",
  "pdf_url": "https://www.leveredge.ai/r/audit-id/pdf"
}

חבילות ומכסות

המכסה מתאפסת בתחילת כל חודש לפי UTC. יחידות שלא נוצלו אינן מצטברות לחודש הבא.

המכסה נצרכת עם קבלת הבקשה ליצירת הדוח, גם אם הניתוח נכשל בהמשך. אין זיכוי אוטומטי במסלול API. במקרה של כשל אפשר לפנות אלינו עם מזהה הדוח.

טיפול בשגיאות בלי ליצור דוחות כפולים

אין כרגע מפתח למניעת כפילויות ביצירה. אם בקשת POST נקטעה, אל תשלחו אותה שוב אוטומטית. אם התקבל מזהה, המשיכו בקריאות GET לאותו דוח; אם לא, פנו לתמיכה לפני יצירה נוספת.