مقدمة
واجهة برمجة تطبيقات CrewAI AMP
Section titled “واجهة برمجة تطبيقات CrewAI AMP”مرحبًا بك في مرجع واجهة برمجة تطبيقات CrewAI AMP. تتيح لك هذه الواجهة التفاعل برمجيًا مع الأطقم المنشورة، مما يمكّنك من دمجها مع تطبيقاتك وسير عملك وخدماتك.
البدء السريع
Section titled “البدء السريع”- الحصول على بيانات اعتماد API
انتقل إلى صفحة تفاصيل طاقمك في لوحة تحكم CrewAI AMP وانسخ رمز Bearer من علامة تبويب الحالة.
- اكتشاف المدخلات المطلوبة
استخدم نقطة النهاية
GET /inputsلمعرفة المعاملات التي يتوقعها طاقمك. - بدء تنفيذ الطاقم
استدعِ
POST /kickoffمع مدخلاتك لبدء تنفيذ الطاقم واستلامkickoff_id. - مراقبة التقدم
استخدم
GET /status/{kickoff_id}للتحقق من حالة التنفيذ واسترجاع النتائج.
المصادقة
Section titled “المصادقة”تتطلب جميع طلبات API المصادقة باستخدام رمز Bearer. أدرج رمزك في ترويسة Authorization:
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \ https://your-crew-url.crewai.com/inputsأنواع الرموز
Section titled “أنواع الرموز”| نوع الرمز | النطاق | حالة الاستخدام |
|---|---|---|
| Bearer Token | وصول على مستوى المؤسسة | عمليات الطاقم الكاملة، مثالي للتكامل بين الخوادم |
| User Bearer Token | وصول محدد بالمستخدم | صلاحيات محدودة، مناسب للعمليات الخاصة بالمستخدم |
عنوان URL الأساسي
Section titled “عنوان URL الأساسي”لكل طاقم منشور نقطة نهاية API فريدة خاصة به:
https://your-crew-name.crewai.comاستبدل your-crew-name بعنوان URL الفعلي لطاقمك من لوحة التحكم.
سير العمل النموذجي
Section titled “سير العمل النموذجي”- الاكتشاف: استدعِ
GET /inputsلفهم ما يحتاجه طاقمك - التنفيذ: أرسل المدخلات عبر
POST /kickoffلبدء المعالجة - المراقبة: استعلم عن
GET /status/{kickoff_id}حتى الاكتمال - النتائج: استخرج المخرجات النهائية من الاستجابة المكتملة
معالجة الأخطاء
Section titled “معالجة الأخطاء”تستخدم الواجهة أكواد حالة HTTP القياسية:
| الكود | المعنى |
|---|---|
200 | نجاح |
400 | طلب غير صالح - تنسيق مدخلات غير صحيح |
401 | غير مصرّح - رمز bearer غير صالح |
404 | غير موجود - المورد غير موجود |
422 | خطأ في التحقق - مدخلات مطلوبة مفقودة |
500 | خطأ في الخادم - تواصل مع الدعم |
الاختبار التفاعلي
Section titled “الاختبار التفاعلي”تعرض لك كل صفحة نقطة نهاية:
- تنسيق الطلب الدقيق مع جميع المعاملات
- أمثلة الاستجابة لحالات النجاح والخطأ
- عينات الكود بلغات متعددة (cURL، Python، JavaScript، إلخ)
- أمثلة المصادقة بتنسيق رمز Bearer الصحيح
لاختبار واجهتك الفعلية:
Section titled “لاختبار واجهتك الفعلية:”نسخ أمثلة cURL
انسخ أمثلة cURL واستبدل العنوان URL + الرمز بقيمك الحقيقية
استخدام Postman/Insomnia
استورد الأمثلة في أداة اختبار API المفضلة لديك
مثال على سير العمل:
- انسخ مثال cURL هذا من أي صفحة نقطة نهاية
- استبدل
your-actual-crew-name.crewai.comبعنوان URL الحقيقي لطاقمك - استبدل رمز Bearer برمزك الحقيقي من لوحة التحكم
- نفّذ الطلب في طرفيتك أو عميل API