مستندات

یادداشت
سطح کارشناسی
کلید API باید به عنوان یک توکن حامل در هدر مجوز درخواست ارسال شود. کلید API خود را دریافت کنید.
لیست

نقطه پایانی API:

GET 
https://aicontent.webnest.ir/api/v1/documents

نمونه درخواست: 

curl --location --request GET 'https://aicontent.webnest.ir/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیح
search
اختیاری string
عبارت جستجو
search_by
اختیاری string
جستجو براساس. مقادیر ممکن عبارتند از: :مقدار برای نام, :مقدار برای نتیجه. پیشفرض برای: name.
template_id
اختیاری integer
فیلتر بر اساس شناسه الگو. مقادیر ممکن عبارتند از: :مقدار برای سبک آزاد, :مقدار برای درباره ما, :مقدار برای تبلیغ, :مقدار برای مقاله, :مقدار برای معرفی بلاگ, :مقدار برای طرح کلی وبلاگ, :مقدار برای پایان بلاگ, :مقدار برای پاراگراف بلاگ, :مقدار برای نوشته بلاگ, :مقدار برای بخش بلاگ, :مقدار برای نکات صحبت در وبلاگ, :مقدار برای عنوان بلاگ, :مقدار برای فراخوان به اقدام, :مقدار برای بازنویسی محتوا, :مقدار برای خلاصه محتوا, :مقدار برای پزسش و پاسخ, :مقدار برای هشتگ, :مقدار برای عنوان, :مقدار برای چگونه کار می کند, :مقدار برای توضیحات متا, :مقدار برای کلمات کلیدی متا, :مقدار برای بیانیه ماموریت, :مقدار برای خبرنامه, :مقدار برای درد - هم زدن - راه حل, :مقدار برای پاراگراف, :مقدار برای بیانیه مطبوعاتی, :مقدار برای پست شبکه اجتماعی, :مقدار برای کپشن پست اجتماعی, :مقدار برای ایده های استارتاپی, :مقدار برای اسامی استارت آپ ها, :مقدار برای عنوان فرعی, :مقدار برای گواهینامه, :مقدار برای تویئت, :مقدار برای تاپیک توییتر, :مقدار برای گزاره ارزش, :مقدار برای توضیح ویدئو, :مقدار برای اسکریپت ویدیویی, :مقدار برای برچسب ویدئو, :مقدار برای عنوان ویدئو, :مقدار برای بیانیه چشم انداز, :مقدار برای برگه محصول, :مقدار برای ایمیل خوش آمد گویی, :مقدار برای پوش نوتیفیکیشن, :مقدار برای فهرست وبلاگ, :مقدار برای گرامر محتوا, :مقدار برای برچسب های وبلاگ, :مقدار برای مزایا و معایب, :مقدار برای تبلیغات گوگل, :مقدار برای تبلیغ فیسبوک, :مقدار برای شرح شغل, :مقدار برای مرور, :مقدار برای بخش ویژگی. پیشفرض برای: freestyle.
favorite
اختیاری boolean
فیلتر بر اساس موارد دلخواه
sort_by
اختیاری string
مرتب سازی بر اساس. مقادیر ممکن عبارتند از: :مقدار برای تاریخ ایجاد, :مقدار برای نام. پیشفرض برای: id.
sort
اختیاری string
ترتیب. مقادیر ممکن عبارتند از: :مقدار برای نزولی, :مقدار برای صعودی. پیشفرض برای: desc.
per_page
اختیاری int
نتیجه در هر صفحه. مقادیر ممکن عبارتند از: 10, 25, 50, 100. پیشفرض برای: 10.
نمایش

نقطه پایانی API:

GET 
https://aicontent.webnest.ir/api/v1/documents/{id}

نمونه درخواست: 

curl --location --request GET 'https://aicontent.webnest.ir/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
ذخیره

نقطه پایانی API:

POST 
https://aicontent.webnest.ir/api/v1/documents

نمونه درخواست: 

curl --location --request POST 'https://aicontent.webnest.ir/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
پارامتر
نوع
توضیح
name
ضروری string
نام قالب
prompt
ضروری string
دستورالعمل های مربوط به هوش مصنوعی
creativity
ضروری float
The creative level of the result. مقادیر ممکن عبارتند از: :مقدار برای تکراری, :مقدار برای قطعی, :مقدار برای اورجینال, :مقدار برای خلاق, :مقدار برای تخیلی. پیشفرض برای: 0.5.
بروزرسانی

نقطه پایانی API:

PUT PATCH 
https://aicontent.webnest.ir/api/v1/documents/{id}

نمونه درخواست: 

curl --location --request PUT 'https://aicontent.webnest.ir/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیح
name
اختیاری string
نام قالب
result
اختیاری string
نتیجه سند
favorite
اختیاری boolean
این که آیا سند مورد علاقه است یا خیر.
حذف

نقطه پایانی API:

DELETE 
https://aicontent.webnest.ir/api/v1/documents/{id}

نمونه درخواست: 

curl --location --request DELETE 'https://aicontent.webnest.ir/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'