KolWrite KolWrite מפתחים

אימות והיקפי הרשאה

אסימוני גישה אישיים

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

אפשר לשלוח את האסימון בכל אחת מהדרכים הבאות — הן שקולות:

Authorization: Bearer kol_...
X-API-Key: kol_...

היקפי הרשאה

אסימון מאפשר לשלוח בקשות רק לנקודות קצה שנכללות בהיקפי ההרשאה שהוקצו לו. ליד כל פעולה במפרט מצוין היקף ההרשאה הנדרש לה (x-required-scope במפרט OpenAPI).

היקף הרשאההרשאות
files:readהצגה והורדה של קבצים, תיקיות, מדיה והעלאות; קריאת נתוני השימוש באחסון
files:writeהעלאת קבצים, רישום מדיה, יצירה או עדכון של תיקיות וסביבות עבודה
jobs:readקריאת מצב משימה, מיקום בתור, תוצאות ותוצרי המשימה
jobs:writeיצירה וביטול של משימות (תמלול, צריבת כתוביות); שינוי סדר התור
transcripts:readקריאת תמלילים, גרסאות וכתובות URL להורדת ייצוא
transcripts:writeשמירת גרסאות תמליל חדשות ושחזור גרסאות קודמות
ai:useשימוש ב-AI המנוהל של KolWrite (צ'אט, הטמעות, תמלול מהיר); צורך קרדיטים
copilot:writeהפעלת AI מדודה ושמירת השיחות ב-Copilot הכללי או ב-Copilot של תמליל מורשה
shares:readהצגה ובדיקה של קישורי שיתוף ציבוריים
shares:writeיצירה, עדכון, החלפה וביטול של קישורי שיתוף ציבוריים
devices:readהצגת סשנים מחוברים במכשירים
devices:writeניתוק סשנים במכשירים
account:readקריאת דגלי תכונות והעדפות חוויית היישום
account:writeעדכון העדפות חוויית היישום
billing:readקריאת יתרת הקרדיטים, היומן וההקצאות

הגדרות מוכנות ביישום: קריאה בלבד (כל היקפי ההרשאה מסוג *:read), אוטומציה (files:*, jobs:*, transcripts:read, billing:read), גישה מלאה.

שגיאות הרשאה

היקף הרשאה חסר בנקודת קצה נתמכת:

{"detail": {"code": "insufficient_scope",
            "message": "This endpoint requires the 'jobs:write' scope",
            "required_scope": "jobs:write"}}

נקודת קצה שאינה זמינה לאסימוני גישה אישיים:

{"detail": {"code": "pat_route_not_allowed",
            "message": "This endpoint is not available to personal access tokens"}}

שני המקרים מחזירים HTTP 403. אסימונים לא תקינים או מבוטלים מחזירים HTTP 401 עם invalid_api_key.

קרדיטים וחיוב

בעת יצירת משימה מוקצים לה קרדיטים, וההתחשבנות מתבצעת בסיומה; קריאות AI נמדדות לפי השימוש בטוקנים. בדקו את ההוצאות באמצעות billing:read:

גרסת Markdown של העמוד