תיעוד
API של האזור האישי

API של האזור האישי

Markdown

מתודות האזור האישי: התחברות, פרופיל, מפתחות והיסטוריית הוצאות.

המדריך המלא

כתובות ואימות

  • האזור האישי: https://ailoot.ai (התחברות עם פרטי החשבון, טוקן של האזור האישי)
  • API המודלים: https://api.ailoot.ai (מפתח sk-…)
מהכתובתאימות
API של האזור האישיhttps://ailoot.ai/api/v1Authorization: Bearer $TOKEN — טוקן של האזור האישי לאחר התחברות
API המודליםhttps://api.ailoot.ai/v1מפתח sk-… מהסעיף "מפתחות API"; ראו מפתחות וכתובת ה-API

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

קריאת הפרופיל שלכם
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

פורמט התשובה ושגיאות

התשובה מכילה code, message ו-data. בשגיאה עשויים להופיע reason ו-metadata. החלוקה לעמודים בתוך data מכילה items, total, page, page_size ו-pages. הפורמט של כל מתודה מצוין בתיאור שלה.

מבנה תשובה עם חלוקה לעמודים
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20,
    "pages": 1
  }
}

הטוקן של האזור האישי נבדק לפי תוקפו ולפי השאלה אם המשתמש פעיל; אם קישור הסשן מופעל — גם לפי IP ודפדפן. הקודים TOKEN_EXPIRED, TOKEN_REVOKED, USER_INACTIVE, INVALID_TOKEN ו-FORBIDDEN מבחינים בין בעיות בסשן ובעיות בהרשאות. מגבלת הקצב ואימות נוסף באמצעות 2FA עשויים לחסום בקשה מסוימת.

איך לקרוא את המדריך

  • כל רשומה מכילה מתודת HTTP, נתיב מלא, תנאי גישה, פרמטרים, שדות גוף הבקשה ותשובה.
  • קחו את המזהים מהתשובה הקודמת: KEY_ID — מ-GET /api/v1/keys, ומזהה הבקשה — מ-GET /api/v1/usage.
  • שדות האובייקטים והטיפוסים שלהם מופיעים בעמודי "סכמות נתונים".
  • התבניות מציגות שמות שדות וטיפוסים. PLACEHOLDER ו-TOKEN הם סמנים; אין כאן נתונים אמיתיים.
  • הוספת כסף ליתרה נמצאת בסעיף "תעריפים" באזור האישי: איך להוסיף כסף.

יתרה ו-frozen_balance

הפרופיל מכיל balance ו-frozen_balance. frozen_balance הוא הסכום שנשמר כרזרבה לבקשות שלא הושלמו. בדקו את שני השדות יחד עם ההיסטוריה.

מפתחות ומגבלות

GET /api/v1/keys מחזיר את המפתחות שלכם. השדות quota וכן quota_used — מגבלת ההוצאות של המפתח והחלק שכבר נוצל; ip_whitelist, ip_blacklist, status וכן expires_at קובעים כיצד אפשר להשתמש במפתח; rate_limit_5h, rate_limit_1d וכן rate_limit_7d — מגבלות הוצאות לפי חלונות זמן.

רשימה והמפתח שלכם
curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
  -H "Authorization: Bearer $TOKEN"

# KEY_ID — ה-id של המפתח שלכם מתשובת הרשימה
curl --fail-with-body "https://ailoot.ai/api/v1/keys/$KEY_ID" \
  -H "Authorization: Bearer $TOKEN"

הוצאות ואבטחה

ההיסטוריה וה-dashboard מציגים actual_cost — החיוב בפועל, ו-total_cost — העלות לפי המחיר הרגיל. מסנני התאריך, המודל, המפתח וסוג הבקשה מפורטים במתודה. שינוי סיסמה, TOTP ו-passkey דורשים את האימותים המתוארים במתודות המתאימות.

בסעיף הזה: 39 מתודות.

נשארו שאלות? שלחו Request ID ותיאור — נעזור לברר.פנייה לתמיכה