דילוג לתוכן
NotHolyתיעוד

התחלה

אימות

מפתח ה-API נשלח כ-Bearer token או בכותרת x-api-key. מפתחות שייכים לארגון ויכולים לכלול תקציבים ומגבלות מודלים.

להציג כ-Markdown

כל בקשה צריכה מפתח API. אפשר לשלוח אותו באחת משתי כותרות:

כותרתפורמט
AuthorizationBearer nh_live_...
x-api-keynh_live_... (מה שה-SDK של Anthropic שולח)
curl
curl https://api.notholy.com/v1/models -H "x-api-key: $NOTHOLY_API_KEY"

מפתחות

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

אפשר להגדיר למפתח:

  • תקציב כולל ותקציב יומי בדולרים. כשמה שנשאר מהתקציב לא מכסה בקשה, מגבלת הפלט שלה מצטמצמת בהתאם, ומתחת ל-16 טוקנים הבקשה מקבלת 402 key_budget_exceeded.
  • רשימת מודלים מותרים. בקשה למודל אחר מקבלת 403 key_not_allowed.
  • תאריך תפוגה.
  • רשימת כתובות IP או טווחי CIDR מורשים. כתובות אחרות מקבלות 403 key_not_allowed.

ביטול מפתח נכנס לתוקף בבקשה הבאה.

מפתחות בקוד

יש לקרוא את המפתח ממשתני הסביבה, ולא לעשות לו commit. אם מפתח דלף, יש לבטל אותו בקונסולה וליצור מפתח חדש.

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

Python
import os
from openai import OpenAI

client = OpenAI(base_url="https://api.notholy.com/v1", api_key=os.environ["NOTHOLY_API_KEY"])

print([m.id for m in client.models.list()])

שגיאות

סטטוסקודמשמעות
401invalid_api_keyמפתח חסר, שגוי, מבוטל או שפג תוקפו
403key_not_allowedהמפתח לא מורשה להשתמש במודל הזה, או שאי אפשר להשתמש בו מכתובת ה-IP הזו
403account_suspendedהארגון מושעה. יש לפנות לתמיכה
403consent_requiredההסכמה לעיבוד במדינות שותפות נדחתה או נמשכה בחשבון שיצר את המפתח. אפשר לאשר אותה בקונסולה

הבא