mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28:10 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
136 lines
5.6 KiB
Plaintext
136 lines
5.6 KiB
Plaintext
---
|
|
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 /{kickoff_id}/status` للتحقق من حالة التنفيذ واسترجاع النتائج.
|
|
</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 /{kickoff_id}/status` حتى الاكتمال
|
|
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>
|