التوثيقAPI v1
أقسام التوثيق

طلبك الأول

أعدّ مفتاحًا على الخادم واقرأ الوكلاء في مساحة عملك.

قبل أن تبدأ

تحتاج إلى بيئة تطوير مفعّلة وعنوان واجهتها ومفتاح لمساحة العمل بصلاحية read. أنشئ المفتاح أو اطلبه من مساحة عملك. خزّنه على الخادم بعيدًا عن المستودع وملفات المتصفّح.

# Set these in your server environment.
# Use the actual base URL supplied for your workspace.
MUWKL_BASE_URL="https://your-assigned-api-host"
MUWKL_API_KEY="your-workspace-key"

اعرض الوكلاء

أرسل طلب GET إلى /v1/agents مع مفتاح Bearer. يحدّد المفتاح مساحة العمل؛ لا تُضف محدّد المستأجر في جسم الطلب أو معاملات الاستعلام.

curl "$MUWKL_BASE_URL/v1/agents" \
  -H "Authorization: Bearer $MUWKL_API_KEY"

اقرأ الاستجابة

تحتوي الاستجابة الناجحة على agents وnext_cursor. المصفوفة الفارغة نتيجة صالحة. تابع المؤشّر عند وجوده، ولا تفترض أن كل وكيل في حالة تشغيل.

{
  "agents": [],
  "next_cursor": null
}

انتقل إلى محادثة

اختر وكيلًا في حالة live وامنح صلاحية converse المنفصلة، ثم اتبع مرجع المحادثات لإنشاء محادثة وإرسال رسالة. احتفظ بصلاحية read إذا كان التكامل يحتاج إلى قراءة النتائج.