تخطَّ إلى المحتوى

مقدمة

واجهة برمجة تطبيقات CrewAI AMP

Section titled “واجهة برمجة تطبيقات CrewAI AMP”

مرحبًا بك في مرجع واجهة برمجة تطبيقات CrewAI AMP. تتيح لك هذه الواجهة التفاعل برمجيًا مع الأطقم المنشورة، مما يمكّنك من دمجها مع تطبيقاتك وسير عملك وخدماتك.

  1. الحصول على بيانات اعتماد API

    انتقل إلى صفحة تفاصيل طاقمك في لوحة تحكم CrewAI AMP وانسخ رمز Bearer من علامة تبويب الحالة.

  2. اكتشاف المدخلات المطلوبة

    استخدم نقطة النهاية GET /inputs لمعرفة المعاملات التي يتوقعها طاقمك.

  3. بدء تنفيذ الطاقم

    استدعِ POST /kickoff مع مدخلاتك لبدء تنفيذ الطاقم واستلام kickoff_id.

  4. مراقبة التقدم

    استخدم GET /status/{kickoff_id} للتحقق من حالة التنفيذ واسترجاع النتائج.

تتطلب جميع طلبات API المصادقة باستخدام رمز Bearer. أدرج رمزك في ترويسة Authorization:

Terminal window
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
https://your-crew-url.crewai.com/inputs
نوع الرمزالنطاقحالة الاستخدام
Bearer Tokenوصول على مستوى المؤسسةعمليات الطاقم الكاملة، مثالي للتكامل بين الخوادم
User Bearer Tokenوصول محدد بالمستخدمصلاحيات محدودة، مناسب للعمليات الخاصة بالمستخدم

لكل طاقم منشور نقطة نهاية API فريدة خاصة به:

https://your-crew-name.crewai.com

استبدل your-crew-name بعنوان URL الفعلي لطاقمك من لوحة التحكم.

  1. الاكتشاف: استدعِ GET /inputs لفهم ما يحتاجه طاقمك
  2. التنفيذ: أرسل المدخلات عبر POST /kickoff لبدء المعالجة
  3. المراقبة: استعلم عن GET /status/{kickoff_id} حتى الاكتمال
  4. النتائج: استخرج المخرجات النهائية من الاستجابة المكتملة

تستخدم الواجهة أكواد حالة HTTP القياسية:

الكودالمعنى
200نجاح
400طلب غير صالح - تنسيق مدخلات غير صحيح
401غير مصرّح - رمز bearer غير صالح
404غير موجود - المورد غير موجود
422خطأ في التحقق - مدخلات مطلوبة مفقودة
500خطأ في الخادم - تواصل مع الدعم

تعرض لك كل صفحة نقطة نهاية:

  • تنسيق الطلب الدقيق مع جميع المعاملات
  • أمثلة الاستجابة لحالات النجاح والخطأ
  • عينات الكود بلغات متعددة (cURL، Python، JavaScript، إلخ)
  • أمثلة المصادقة بتنسيق رمز Bearer الصحيح

لاختبار واجهتك الفعلية:

Section titled “لاختبار واجهتك الفعلية:”

نسخ أمثلة cURL

انسخ أمثلة cURL واستبدل العنوان URL + الرمز بقيمك الحقيقية

استخدام Postman/Insomnia

استورد الأمثلة في أداة اختبار API المفضلة لديك

مثال على سير العمل:

  1. انسخ مثال cURL هذا من أي صفحة نقطة نهاية
  2. استبدل your-actual-crew-name.crewai.com بعنوان URL الحقيقي لطاقمك
  3. استبدل رمز Bearer برمزك الحقيقي من لوحة التحكم
  4. نفّذ الطلب في طرفيتك أو عميل API