مستندات API

Descriptionاین Endpoint یک متن برای خلاصه‌سازی و تعداد جملاتی که می‌خواهید متن خروجی داشته باشد را دریافت می کند و در خروجی متن خلاصه شده را ارسال می کند.
URLhttps://api.vakavic.com/summarizer/summarizetext
MethodPOST
Content-Typeapplication/json
Authorization
  • در هر درخواستی که به API ارسال می شود، هدر Authorization باید به شکل زیر ارسال شود:
  • Authorization: Bearer YOUR_API_TOKEN
  • API Token: کلید دسترسی به API است که پس از ثبت نام در وبسایت از صفحه تنظیمات حساب کاربری قابل دسترسی است.
  • Data Params
    {
        text: [String],
        sentenceCount: [number]
    }
  • text: متن مورد نظر برای خلاصه‌سازی
  • SentenceCount: تعداد جملات متن خروجی (متن در چند جمله خلاصه شود)
  • Success Response
    {
        Success: [boolean],
        remaningAPICalls: [Number],
        summary: [String]
    }                          
  • Success: مشخص می کند که پردازش با موفقیت انجام شده است یا نه.
  • remaningAPICalls: تعداد فراخوانی API باقیمانده در این ماه.
  • Summary: متن خلاصه شده
  • Error Response
    {
        Success: false,
        message: [String],
    }
  • message: توضیح مشکل پیش آمده