چت‌ها

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

پایانه API:

GET 
https://ai.mr-web.ir/api/v1/chats

مثال درخواست: 

curl --location --request GET 'https://ai.mr-web.ir/api/v1/chats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
اختیاری string
متن جستجو.
search_by
اختیاری string
جستجو بر اساس. مقادیر ممکن هستند: :مقدار برای نام. مقدار پیش فرض: name.
favorite
اختیاری boolean
فیلتر براساس علاقه مندی.
sort_by
اختیاری string
مرتب سازی بر اساس. مقادیر ممکن هستند: :مقدار برای تاریخ ایجاد, :مقدار برای نام. مقدار پیش فرض: id.
sort
اختیاری string
مرتب‌سازی. مقادیر ممکن هستند: :مقدار برای نزولی, :مقدار برای صعودی. مقدار پیش فرض: desc.
per_page
اختیاری int
نتایج در هر صفحه. مقادیر ممکن هستند: 10, 25, 50, 100. مقدار پیش فرض: 10.
نمایش

پایانه API:

GET 
https://ai.mr-web.ir/api/v1/chats/{id}

مثال درخواست: 

curl --location --request GET 'https://ai.mr-web.ir/api/v1/chats/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
فروشگاه

پایانه API:

POST 
https://ai.mr-web.ir/api/v1/chats

مثال درخواست: 

curl --location --request POST 'https://ai.mr-web.ir/api/v1/chats' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'
پارامتر
نوع
توضیحات
name
الزامی string
نام چت.
به روزرسانی

پایانه API:

PUT PATCH 
https://ai.mr-web.ir/api/v1/chats/{id}

مثال درخواست: 

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

پایانه API:

DELETE 
https://ai.mr-web.ir/api/v1/chats/{id}

مثال درخواست: 

curl --location --request DELETE 'https://ai.mr-web.ir/api/v1/chats/{id}' \
--header 'Authorization: Bearer {api_key}'