شروع کار
مرور کلی API نسخهٔ ۲
معرفی API نسخهٔ ۲ موچت؛ یک REST API ساختاریافته و مدرن برای گفتگو با ایجنتهای هوش مصنوعی و مدیریت گفتگوها.
API نسخهٔ ۲ موچت چیست؟
API نسخهٔ ۲ موچت یک REST API بازطراحیشده است که رابطی ساده و یکدست برای تعامل با ایجنتهای هوش مصنوعی شما فراهم میکند. این API دارای کدهای خطای ساختاریافته، صفحهبندی مبتنی بر نشانگر، پشتیبانی از پاسخهای جریانی از طریق رویدادهای ارسالی سرور (Server-Sent Events) و قالب پاسخی قابل پیشبینی است.
URL پایه:
https://api.mu.chat/api/v2شروع سریع
کلید API خود را دریافت کنید
- به داشبورد موچت بروید
- به تنظیمات فضای کاری ← کلیدهای API بروید
- روی ایجاد کلید API کلیک کنید و کلید ایجادشده را کپی کنید
شناسه ایجنت خود را دریافت کنید
- ایجنت هوش مصنوعی خود را در داشبورد انتخاب کنید
- به تنظیمات ← عمومی ایجنت هوش مصنوعی بروید
- شناسهٔ ایجنت را از کارت جزئیات ایجنت کپی کنید
اولین پیام خود را ارسال کنید
curl -X POST 'https://api.mu.chat/api/v2/agents/YOUR_AGENT_ID/chat' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"message": "Hello! How can you help me?"
}'پاسخ:
{
"data": {
"id": "msg_abc123",
"role": "assistant",
"parts": [
{ "type": "text", "text": "Hello! I'm here to help. What can I assist you with today?" }
],
"metadata": {
"userMessageId": "msg_xyz789",
"conversationId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"userId": null,
"finishReason": "stop",
"usage": { "credits": 2 }
}
}
}نقاط پایانی
URL پایه: https://api.mu.chat/api/v2
| روش | نقطهٔ پایانی | یادداشتها |
|---|---|---|
GET | /api/v2/health | |
GET | /api/v2/agents | |
POST | /api/v2/agents | |
GET | /api/v2/agents/{agentId} | |
PUT | /api/v2/agents/{agentId} | |
DELETE | /api/v2/agents/{agentId} | |
PUT | /api/v2/agents/{agentId}/styles | |
PUT | /api/v2/agents/{agentId}/auto-retrain | (زمانبندی همگامسازی مجدد خودکار) |
POST | /api/v2/agents/{agentId}/clone | |
POST | /api/v2/agents/{agentId}/train | (منسوخ، بدون عملیات) |
POST | /api/v2/agents/{agentId}/chat | |
POST | /api/v2/agents/{agentId}/conversations/{conversationId}/retry | |
GET | /api/v2/agents/{agentId}/conversations | |
GET | /api/v2/agents/{agentId}/conversations/export | |
GET | /api/v2/agents/{agentId}/conversations/search | |
GET | /api/v2/agents/{agentId}/conversations/{conversationId} | |
GET | /api/v2/agents/{agentId}/conversations/{conversationId}/messages | |
GET | /api/v2/agents/{agentId}/users/{userId}/conversations | |
POST | /api/v2/agents/{agentId}/conversations/{conversationId}/tool-result | |
PATCH | /api/v2/agents/{agentId}/conversations/{conversationId}/messages/{messageId}/feedback | |
GET | /api/v2/agents/{agentId}/sources/summary | |
GET | /api/v2/agents/{agentId}/sources | |
POST | /api/v2/agents/{agentId}/sources | |
GET | /api/v2/agents/{agentId}/sources/{sourceId} | |
PUT | /api/v2/agents/{agentId}/sources/{sourceId} | |
DELETE | /api/v2/agents/{agentId}/sources/{sourceId} | |
POST | /api/v2/agents/{agentId}/sources/{sourceId}/restore | (منسوخ، بدون عملیات) |
نشانی پایهٔ بارگذاری فایل: https://api.mu.chat/api/v2
| روش | نقطهٔ پایانی | یادداشتها |
|---|---|---|
POST | /api/v2/agents/{agentId}/sources | |
PUT | /api/v2/agents/{agentId}/sources/{sourceId} |
سربرگهای پاسخ
هر پاسخ شامل این سربرگهاست:
| سربرگ | توضیحات |
|---|---|
x-request-id | شناسهٔ یکتای درخواست. هنگام تماس با پشتیبانی این شناسه را ارائه کنید. |
X-RateLimit-Limit | حداکثر تعداد درخواست مجاز در بازهٔ زمانی فعلی. |
X-RateLimit-Remaining | تعداد درخواستهای باقیمانده در بازهٔ زمانی فعلی. |
X-RateLimit-Reset | مُهر زمانی Unix برحسب ثانیه که زمان بازنشانی بازهٔ محدودیت نرخ درخواست را مشخص میکند. |