דילוג לתוכן
תיעוד ה־API

שגיאות

כל שגיאה היא application/problem+json. השדה code הוא אחד מאלה, ו־type מוביל לשורה שלו כאן.

כל השגיאות

ב־4xx מתקנים את הבקשה, ב־5xx מנסים שוב עם אותו Idempotency-Key. בכל שגיאה יש call_id, שאפשר לפתוח ביומן הקריאות עם הבקשה המלאה.

  • unauthorized401

    אין מפתח תקין

    Missing or invalid API key

    הבקשה הגיעה בלי מפתח, או עם מפתח שלא קיים.

    שלחו Authorization: Bearer עם מפתח מעמוד המפתחות.

  • key-expired401

    תוקף המפתח פג

    API key expired

    למפתח נקבע תאריך תפוגה, והוא עבר.

    צרו מפתח חדש. בפעם הבאה, החליפו סוד לפני התפוגה: הישן ממשיך לעבוד עוד 24 שעות.

  • key-revoked401

    המפתח בוטל

    API key revoked

    מפתח שבוטל לא עובד יותר.

    צרו מפתח חדש בעמוד המפתחות.

  • forbidden-scope403

    חסרה הרשאה

    The key lacks the scope this call needs

    למפתח אין את ההרשאה שהקריאה צריכה, למשל יצירה.

    צרו מפתח עם ההרשאה, או קראו עם מפתח אחר.

  • not-found404

    לא נמצא

    Not found

    הנתיב לא קיים, או שהמשאב לא קיים בחשבון של המפתח.

    בדקו את הנתיב ואת המזהה. משאב של חשבון אחר תמיד נראה כלא קיים.

  • method-not-allowed405

    שיטה לא נתמכת

    Method not allowed

    הנתיב קיים, אבל לא בשיטה הזו.

    הכותרת Allow מפרטת את השיטות שהנתיב מקבל.

  • invalid-json400

    JSON לא תקין

    Malformed JSON body

    לא הצלחנו לקרוא את גוף הבקשה כ־JSON.

    שלחו Content-Type: application/json וגוף JSON תקין.

  • idempotency-key-required400

    חסר Idempotency-Key

    Idempotency-Key header required

    הקריאה יוצרת משהו שעולה כסף, ולכן חייבת Idempotency-Key.

    שלחו מפתח ייחודי לכל בקשה, למשל UUID.

  • idempotency-key-invalid400

    Idempotency-Key לא תקין

    Idempotency-Key must be 8 to 150 printable ASCII characters

    הערך קצר או ארוך מדי, או כולל תווים לא חוקיים.

    8 עד 150 תווי ASCII מודפסים. UUID מתאים בדיוק.

  • payload-too-large413

    הבקשה גדולה מדי

    Request body too large

    גוף הבקשה עובר את הגודל שה־API מקבל.

    קבצים עולים דרך POST /v1/uploads וכתובת חתומה, לא בגוף הבקשה.

  • invalid-input422

    קלט לא תקין

    Invalid input

    שדה חסר או לא תקין.

    המערך errors בתשובה מפרט כל שדה ומה לא בסדר בו.

  • idempotency-key-reused422

    Idempotency-Key תפוס

    Idempotency-Key reused with a different request

    אותו Idempotency-Key נשלח עם בקשה אחרת.

    מפתח חדש לכל בקשה חדשה. אותו מפתח רק לניסיון חוזר של אותה בקשה בדיוק.

  • idempotency-in-flight409

    הבקשה עוד רצה

    A request with this Idempotency-Key is still running

    בקשה עם אותו Idempotency-Key עדיין רצה.

    חכו שנייה ונסו שוב עם אותו מפתח: תקבלו את התשובה של הבקשה הראשונה.

  • price-changed409

    המחיר השתנה

    The price changed; confirm the new price

    המחיר כבר לא תואם להערכה, למשל כי הסרטון או התוספות השתנו. לא חויבתם.

    הציגו את המחיר החדש מ־estimate שבתשובה, ושלחו שוב עם expected_amount_agorot המעודכן ו־Idempotency-Key חדש.

  • conflict409

    לא אפשרי כרגע

    Conflict

    המשאב לא במצב שמאפשר את הפעולה, למשל סרטון שעוד לא מוכן.

    detail אומר מה חסר. חכו למצב הנכון ונסו שוב.

  • insufficient-credits402

    אין מספיק יתרה

    Insufficient credits

    היתרה לא מכסה את הרינדור. לא חויבתם.

    טענו יתרה בעמוד החיוב, או השתמשו במפתח בדיקה.

  • budget-exceeded402

    התקציב החודשי נוצל

    The project's monthly budget is spent

    הפרויקט של המפתח הגיע לתקציב שהגדרתם לחודש. לא חויבתם.

    הגדילו את התקציב בעמוד הפרויקטים, או חכו לתחילת החודש הבא.

  • key-limit-reached402

    מגבלת המפתח נוצלה

    The key's lifetime limit is spent

    המפתח הגיע למגבלת החיוב הכוללת שלו. לא חויבתם.

    הגדילו את המגבלה בעמוד המפתח.

  • gone410

    כבר לא קיים

    Gone

    המשאב נמחק, או שהקישור שלו פג.

    צרו אותו מחדש, או בקשו את המשאב שוב לקישור חדש.

  • rate-limited429

    יותר מדי קריאות

    Too many requests

    הקצב המותר: 120 בדקה למפתח, מהן 30 שעולות כסף. במצב בדיקה גם 20 רינדורים ביום.

    חכו את מספר השניות שב־Retry-After. הכותרות RateLimit-Limit, RateLimit-Remaining ו־RateLimit-Reset אומרות כמה נשאר.

  • internal500

    תקלה אצלנו

    Internal error

    משהו נשבר בצד שלנו, לא בבקשה. לא חויבתם.

    נסו שוב עם אותו Idempotency-Key. אם זה חוזר, שלחו לנו את call_id שבתשובה.

  • unavailable503

    ה־API לא זמין

    The API is temporarily unavailable

    ה־API מושבת זמנית מצדנו.

    נסו שוב אחרי מספר השניות שב־Retry-After.