شروع کار
معرفی API
با API موچت به ایجنت پیام بفرستید، خروجی مکالمات را بگیرید و پاسخ‌گویی سرویس را بررسی کنید.
API موچت چیست؟
از طریق HTTPS برای ایجنت پیام بفرستید و متن مکالمات را دریافت کنید. پاسخ‌ها JSON هستند، خطاها از قالب RFC 9457 پیروی می‌کنند و خروجی مکالمات صفحه‌بندی نشانگری دارد. کوئری از پاسخ جریانی با Server-Sent Events یا SSE نیز پشتیبانی می‌کند.
نشانی پایه:
https://api.mu.chatشروع سریع
کلید API کانال را بگیرید
در داشبورد، ایجنت را انتخاب کنید و از انتشار ← API ← راه‌اندازی / مدیریت کلید کانال را بسازید یا کپی کنید.
کلید را در متغیرهای محیطی سرور نگه دارید.
اولین پیام را بفرستید
curl --request POST 'https://api.mu.chat/v2/chat' \
--header 'Authorization: Bearer YOUR_CHANNEL_API_KEY' \
--header 'Content-Type: application/json' \
--data '{"query":"Hello!","external_message_id":"message-001","stream":false}'پاسخ شامل data.message و data.metadata است. ساختار کامل و نمونهٔ پاسخ در مرجع کوئری آمده است.
گفتگو را ادامه دهید
مقدار data.metadata.conversation_id را با کوئری بعدی بفرستید. هر پیام تازه باید external_message_id جدید داشته باشد؛ هنگام تکرار همان درخواست، شناسه و بدنهٔ اصلی را حفظ کنید.
برای دریافت رویدادهای جریانی، مقدار stream را true بگذارید.
مسیرهای API
| روش | مسیر | احراز هویت |
|---|---|---|
GET | بررسی سلامت — /v2/health | بدون کلید |
POST | ارسال کوئری — /v2/chat | کلید API کانال |
GET | خروجی مکالمات — /v2/agents/{agent_id}/conversations/export | کلید API پلتفرم |
در کوئری، کلید کانال ایجنت را مشخص می‌کند. خروجی مکالمات به agent_id در مسیر URL و کلید پلتفرم متعلق به سازمان همان ایجنت نیاز دارد.
دریافت متن مکالمات
از تنظیمات ← توسعه‌دهنده ← کلیدهای API یک کلید پلتفرم بسازید و صفحهٔ اول را بگیرید:
curl --get 'https://api.mu.chat/v2/agents/YOUR_AGENT_ID/conversations/export' \
--header 'Authorization: Bearer YOUR_PLATFORM_API_KEY' \
--data-urlencode 'limit=20'متن پیام‌ها در data[].messages[].content_text است. صفحهٔ اول حداکثر ۲۰ ترد جدیدتر بر اساس زمان ایجاد را می‌دهد. تا وقتی pagination.has_more برابر true است، با pagination.next_cursor تردهای قدیمی‌تر را بگیرید. هر ردیف مطابق یک ترد در CSV است و تمام پیام‌های عمومی آن را یکجا، از قدیمی به جدید، دارد. مرجع خروجی مکالمات شامل فیلترها، محدودیت‌ها، فیلدهای پاسخ و نمونهٔ کامل پایتون است.
سربرگ‌های پاسخ
| سربرگ | مسیر | توضیح |
|---|---|---|
X-Request-ID | هر سه مسیر | شناسهٔ درخواست؛ هنگام تماس با پشتیبانی ارسال کنید. |
X-RateLimit-Limit | خروجی مکالمات | سقف درخواست: ۳۰ درخواست در دقیقه برای هر سازمان. |
X-RateLimit-Remaining | خروجی مکالمات | تعداد درخواست‌های باقی‌مانده در بازهٔ فعلی. |
X-RateLimit-Reset | خروجی مکالمات | زمان پایان بازه، به‌صورت Unix timestamp بر حسب ثانیه. |
Retry-After | خطای 429 یا 503 مربوط به سرویس محدودکنندهٔ خروجی | تعداد ثانیه‌های انتظار پیش از تلاش دوباره. |
health پاسخ‌گویی فرایند API را می‌سنجد؛ موفقیت آن سلامت پایگاه داده یا سرویس مدل را تأیید نمی‌کند. قالب خطاها و روش تلاش دوباره در مدیریت خطا آمده است.