ارسال کوئری

POST/v2/chat

با کلید API کانال احراز هویت کنید و متن query یا فایل‌های از قبل آپلودشده را بفرستید. کانال مشخص می‌کند پیام به کدام ایجنت برسد.

ادامهٔ گفتگو و تکرار درخواست

برای ادامهٔ گفتگو، مقدار data.metadata.conversation_id پاسخ قبلی را در درخواست بعدی بفرستید.

پارامتر external_message_id تکرار درخواست را ایمن می‌کند: همان شناسه و بدنه را دوباره بفرستید تا نتیجهٔ اصلی را دریافت کنید. فقط stream می‌تواند تغییر کند. کانال ایجنت را تعیین می‌کند؛ agent_id لازم نیست. کلید API پلتفرم برای این درخواست پذیرفته نمی‌شود.

پاسخ جریانی رویدادها و اتصال مجدد را توضیح می‌دهد. راهنمای اتصال جزئیات مخاطب، آپلود فایل، دستورالعمل هر درخواست و انتخاب منابع دانش را پوشش می‌دهد.

curl --request POST \  --url 'https://api.mu.chat/v2/chat' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{  "query": "Hello!",  "external_message_id": "message-001",  "stream": false}'

{  "data": {    "message": {      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",      "role": "assistant",      "parts": [        {          "id": "c3c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",          "type": "text",          "text": "Hello! How can I help you?"        }      ]    },    "metadata": {      "conversation_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",      "user_message_id": "d4c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",      "external_message_id": "message-001",      "contact_id": "e5c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",      "finish_reason": "completed",      "conversation_status": "open",      "bot_active": true,      "handoff_status": "not_requested",      "usage": {        "credits": 1      }    }  }}

احراز هویت

Authorizationstringheaderالزامی

کلید API کانال از بخش انتشار ← API در داشبورد ایجنت. کانال، ایجنت را مشخص می‌کند. کلید پلتفرم برای کوئری قابل استفاده نیست.

احراز هویت با توکن Bearer و این قالب انجام می‌شود: Bearer <token>

پارامترهای سربرگ

last-event-idstring | null

بدنهٔ درخواستالزامی

ویژگی‌های اضافی

false

querystring

متن پیام برای ایجنت. متن یا حداقل یک پیوست آپلودشده بفرستید.

پیش‌فرض:

attachmentsobject[]

پیوست‌هایی که قبلاً آپلود شده‌اند؛ حداکثر ۵ فایل.

حداکثر تعداد: 5

نمایش ویژگی‌های فرزند

blob_idintegerالزامی

کران پایین غیرشامل: 0

ویژگی‌های اضافی

false

conversation_idstring | null

شناسهٔ مکالمه از پاسخ قبلی. برای شروع گفتگوی جدید، خالی بگذارید.

قالب: uuid

external_message_idstring | null

شناسهٔ یکتای پیام در برنامهٔ شما. هنگام تلاش دوباره، همین شناسه و بدنه را بفرستید.

حداکثر طول: 255

حداقل طول: 1

contactobject | null

مشخصات مخاطبی که به این مکالمه متصل می‌شود.

نمایش ویژگی‌های فرزند

identifierstring | null

حداکثر طول: 255

namestring | null

حداکثر طول: 255

first_namestring | null

حداکثر طول: 255

last_namestring | null

حداکثر طول: 255

emailstring | null

قالب: email

phone_numberstring | null

حداکثر طول: 64

localestring | null

حداکثر طول: 32

custom_attributesobject

ویژگی‌های اضافی

false

system_promptstring | null

دستورالعمل‌های تکمیلی برای همین درخواست.

knowledge_base_idsstring[] | null

پاسخ این درخواست را به منابع دانش انتخاب‌شده محدود کنید.

حداکثر تعداد: 100

streamboolean

برای دریافت رویدادهای جریانی، true را انتخاب کنید. مقدار پیش‌فرض false و پاسخ JSON است.

پیش‌فرض: false

پاسخ

– application/json · text/event-stream

Successful Response

dataobjectالزامی

نمایش ویژگی‌های فرزند

messageobject | nullالزامی

نمایش ویژگی‌های فرزند

idstringالزامی

قالب: uuid

roleenum<string>الزامی

مقادیر مجاز: userassistantoperator

partsobject[]الزامی

anyOf

نمایش ویژگی‌های فرزند

idstringالزامی

قالب: uuid

typeenum<string>

پیش‌فرض: text

textstringالزامی

نمایش ویژگی‌های فرزند

idstringالزامی

قالب: uuid

client_idstring

پیش‌فرض:

positionintegerالزامی

typeenum<string>الزامی

مقادیر مجاز: attachmentvoice

updated_atstringالزامی

قالب: date-time

content_attributesobjectالزامی

نمایش ویژگی‌های فرزند

schema_versionenum<integer>

پیش‌فرض: 1

kindenum<string>الزامی

مقادیر مجاز: imagevoicefile

filenamestringالزامی

statusenum<string>الزامی

مقادیر مجاز: pendingprocessingreadyfailedrejected

content_typestring | null

byte_sizeinteger | null

widthinteger | null

heightinteger | null

duration_secondsnumber | null

error_codestring | null

transcriptionobject | null

delivery_statusstring | null

download_urlstring | null

expires_ininteger | null

ویژگی‌های اضافی

false

metadataobjectالزامی

نمایش ویژگی‌های فرزند

conversation_statusstringالزامی

bot_activebooleanالزامی

handoff_statusenum<string>الزامی

مقادیر مجاز: not_requestedpendingoperator_owned

conversation_idstringالزامی

قالب: uuid

user_message_idstringالزامی

قالب: uuid

external_message_idstringالزامی

contact_idstringالزامی

قالب: uuid

finish_reasonenum<string>الزامی

مقادیر مجاز: completedsuppressedfailedcancelled

usageobject

نمایش ویژگی‌های فرزند

creditsinteger

پیش‌فرض: 0

ادامهٔ گفتگو و تکرار درخواستکپی پیوند عنوان

احراز هویت

پارامترهای سربرگ

بدنهٔ درخواستالزامی

پاسخ

ادامهٔ گفتگو و تکرار درخواست