مستندات

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

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

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

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

curl --location --request GET 'https://aicontent.webnest.ir/api/v1/images' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیح
search
اختیاری string
عبارت جستجو
search_by
اختیاری string
جستجو براساس. مقادیر ممکن عبارتند از: :مقدار برای نام. پیشفرض برای: name.
resolution
اختیاری string
فیلتر براساس وضوح مقادیر ممکن عبارتند از: :مقدار برای 256×256, :مقدار برای 512×512, :مقدار برای 1024×1024.
style
اختیاری string
فیلتر بر اساس سبک مقادیر ممکن عبارتند از: :مقدار برای رندر سه بعدی, :مقدار برای آبستراکت, :مقدار برای انیمه, :مقدار برای هنر دکو, :مقدار برای کارتون, :مقدار برای هنر دیجیتال, :مقدار برای ایلاستریشن, :مقدار برای اوریگامی, :مقدار برای پیکسل آرت, :مقدار برای فتوگرافی, :مقدار برای پاپ آرت, :مقدار برای رترو, :مقدار برای اسکچ, :مقدار برای امواج بخار.
medium
اختیاری string
فیلتر براساس متوسط مقادیر ممکن عبارتند از: :مقدار برای اکریلیک, :مقدار برای بوم, :مقدار برای گچ, :مقدار برای زغال چوبی, :مقدار برای مداد رنگی, :مقدار برای شیشه, :مقدار برای جوهر, :مقدار برای پاستل, :مقدار برای مداد, :مقدار برای رنگ اسپری, :مقدار برای آبرنگ.
filter
اختیاری string
فیلتر براساس فیلتر مقادیر ممکن عبارتند از: :مقدار برای سیاه و سفید, :مقدار برای سپیا, :مقدار برای معکوس کردن.
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/images/{id}

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

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

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

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

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

curl --location --request POST 'https://aicontent.webnest.ir/api/v1/images' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'
پارامتر
نوع
توضیح
name
ضروری string
نام قالب
description
ضروری string
توضیحات تصویر برای هوش مصنوعی.
resolution
ضروری string
وضوح تصویر. مقادیر ممکن عبارتند از: :مقدار برای 256×256, :مقدار برای 512×512, :مقدار برای 1024×1024.
style
اختیاری string
سبک تصویر. مقادیر ممکن عبارتند از: :مقدار برای رندر سه بعدی, :مقدار برای آبستراکت, :مقدار برای انیمه, :مقدار برای هنر دکو, :مقدار برای کارتون, :مقدار برای هنر دیجیتال, :مقدار برای ایلاستریشن, :مقدار برای اوریگامی, :مقدار برای پیکسل آرت, :مقدار برای فتوگرافی, :مقدار برای پاپ آرت, :مقدار برای رترو, :مقدار برای اسکچ, :مقدار برای امواج بخار.
medium
اختیاری string
رسانه تصویر. مقادیر ممکن عبارتند از: :مقدار برای اکریلیک, :مقدار برای بوم, :مقدار برای گچ, :مقدار برای زغال چوبی, :مقدار برای مداد رنگی, :مقدار برای شیشه, :مقدار برای جوهر, :مقدار برای پاستل, :مقدار برای مداد, :مقدار برای رنگ اسپری, :مقدار برای آبرنگ.
filter
اختیاری string
فیلتر تصویر مقادیر ممکن عبارتند از: :مقدار برای سیاه و سفید, :مقدار برای سپیا, :مقدار برای معکوس کردن.
بروزرسانی

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

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

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

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

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

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

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

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