---
title: "مقدمة"
description: "المرجع الكامل لواجهة برمجة تطبيقات CrewAI AMP REST"
icon: "code"
mode: "wide"
---

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

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

## البدء السريع

<Steps>
  <Step title="الحصول على بيانات اعتماد API">
    انتقل إلى صفحة تفاصيل طاقمك في لوحة تحكم CrewAI AMP وانسخ رمز Bearer من علامة تبويب الحالة.
  </Step>

<Step title="اكتشاف المدخلات المطلوبة">
  استخدم نقطة النهاية `GET /inputs` لمعرفة المعاملات التي يتوقعها طاقمك.
</Step>

<Step title="بدء تنفيذ الطاقم">
  استدعِ `POST /kickoff` مع مدخلاتك لبدء تنفيذ الطاقم واستلام
  `kickoff_id`.
</Step>

  <Step title="مراقبة التقدم">
    استخدم `GET /status/{kickoff_id}` للتحقق من حالة التنفيذ واسترجاع النتائج.
  </Step>
</Steps>

## المصادقة

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

```bash
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
  https://your-crew-url.crewai.com/inputs
```

### أنواع الرموز

| نوع الرمز            | النطاق                     | حالة الاستخدام                                                     |
| :-------------------- | :------------------------ | :----------------------------------------------------------- |
| **Bearer Token**      | وصول على مستوى المؤسسة | عمليات الطاقم الكاملة، مثالي للتكامل بين الخوادم |
| **User Bearer Token** | وصول محدد بالمستخدم        | صلاحيات محدودة، مناسب للعمليات الخاصة بالمستخدم   |

<Tip>
  يمكنك العثور على كلا نوعي الرموز في علامة تبويب الحالة من صفحة تفاصيل طاقمك في
  لوحة تحكم CrewAI AMP.
</Tip>

## عنوان URL الأساسي

لكل طاقم منشور نقطة نهاية 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` | خطأ في الخادم - تواصل مع الدعم             |

## الاختبار التفاعلي

<Info>
  **لماذا لا يوجد زر "إرسال"؟** نظرًا لأن كل مستخدم CrewAI AMP لديه عنوان URL
  فريد للطاقم، نستخدم **وضع المرجع** بدلاً من بيئة تفاعلية لتجنب
  الالتباس. يوضح لك هذا بالضبط كيف يجب أن تبدو الطلبات بدون
  أزرار إرسال غير فعالة.
</Info>

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

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

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

<CardGroup cols={2}>
  <Card title="نسخ أمثلة cURL" icon="terminal">
    انسخ أمثلة cURL واستبدل العنوان URL + الرمز بقيمك الحقيقية
  </Card>
  <Card title="استخدام Postman/Insomnia" icon="play">
    استورد الأمثلة في أداة اختبار API المفضلة لديك
  </Card>
</CardGroup>

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

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

## هل تحتاج مساعدة؟

<CardGroup cols={2}>
  <Card
    title="دعم المؤسسات"
    icon="headset"
    href="mailto:support@crewai.com"
  >
    احصل على مساعدة في تكامل API واستكشاف الأخطاء وإصلاحها
  </Card>
  <Card
    title="لوحة تحكم المؤسسات"
    icon="chart-line"
    href="https://app.crewai.com"
  >
    إدارة أطقمك وعرض سجلات التنفيذ
  </Card>
</CardGroup>
