API Overview

أهلاً بك في وثائق Minds API. يتيح لك API الخاص بنا إنشاء وإدارة AI minds برمجياً، ورفع المعرفة، والتفاعل معها.

البدء

Minds API منظَّم حول مبادئ REST. لـ API الخاص بنا URLs موجهة نحو الموارد يمكن توقعها، ويقبل أجسام طلب بترميز JSON، ويُرجع استجابات بترميز JSON، ويستخدم رموز استجابة HTTP ومصادقة وأفعال قياسية.

Base URL

Production: https://getminds.ai/api/v1 أو https://api.getminds.ai/v1

Local Development: http://localhost:3000/api/v1

كلا base URLs للإنتاج متكافئان تماماً. يُوصى بالنطاق الفرعي api.getminds.ai للحصول على URLs تكامل أنظف.

المصادقة

تتطلب جميع endpoints الـ API مصادقة عبر مفتاح API. يمكنك توليد وإدارة مفاتيح API الخاصة بك في Settings → API Keys.

ضمّن مفتاح API الخاص بك في ترويسة Authorization:

Authorization: Bearer minds_your_api_key_here

مواصفة OpenAPI

تُنشَر مواصفة OpenAPI 3.1.0 قابلة للقراءة آليًا على /_openapi.json. استخدم المواصفة لتوليد عملاء بأنواع محددة (TypeScript وPython وغيرها) أو لإسقاطها في نموذج LLM للحصول على كود تكامل بضربة واحدة. راجع OpenAPI للاطّلاع على أمثلة.

Content Type

يجب أن تتضمن جميع الطلبات التي ترسل بيانات ترويسة Content-Type:

Content-Type: application/json

لرفع الملفات، استخدم:

Content-Type: multipart/form-data

Endpoints المتاحة

Minds

أنشئ وأدِر AI minds (agents) بتهيئات مخصصة.

• GET /api/v1/minds — عرض جميع الـ Minds
• GET /api/v1/minds/{mindId} — الحصول على تفاصيل Mind
• POST /api/v1/minds — إنشاء Mind جديد
• PUT /api/v1/minds/{mindId} — تحديث Mind
• DELETE /api/v1/minds/{mindId} — حذف Mind
• POST /api/v1/minds/{mindId}/regenerate-prompt — إعادة توليد نظام البرومبت من المعرفة

Knowledge

أدِر المعرفة للـ minds الخاصة بك.

• GET /api/v1/minds/{mindId}/knowledge — عرض عناصر المعرفة
• POST /api/v1/minds/{mindId}/knowledge — إضافة معرفة (روابط أو ملفات أو بحث بالكلمات المفتاحية)
• PUT /api/v1/minds/{mindId}/knowledge/{itemId} — تحديث عنصر معرفة
• DELETE /api/v1/minds/{mindId}/knowledge/{itemId} — حذف عنصر معرفة
• POST /api/v1/minds/{mindId}/knowledge/enrich — إثراء عبر البحث بالكلمات المفتاحية (اختصار مريح)
• GET /api/v1/minds/{mindId}/knowledge/patterns — الحصول على أنماط المعرفة حسب الإطار

Chat

تفاعل مع الـ minds الخاصة بك عبر إكمالات المحادثة.

• POST /api/v1/minds/{mindId}/completion — إرسال الرسائل والحصول على الاستجابات

Studies

أنشئ وأدِر AI studies لاستطلاع مجموعات من الـ minds.

• GET /api/v1/studies — عرض جميع الـ studies
• POST /api/v1/studies — إنشاء study جديد
• GET /api/v1/studies/{studyId} — الحصول على تفاصيل study مع سجل الرسائل
• POST /api/v1/studies/{studyId}/ask — طرح سؤال على جميع minds الـ study (SSE stream)
• POST /api/v1/studies/{studyId}/export — تصدير نتائج study كتقرير
• GET /api/v1/studies/{studyId}/export-status — فحص حالة مهمة التصدير
• GET /api/v1/studies/{studyId}/export-download — تنزيل PDF المُصدَّر

User

endpoints متعلقة بالمستخدم.

• GET /api/v1/auth/me — الحصول على المستخدم المصادق الحالي
• GET /api/v1/user/shareable-sparks — عرض الـ minds المتاحة للمشاركة

API Keys

أدِر مفاتيح API الخاصة بك للمصادقة.

• GET /api/v1/api-keys — عرض مفاتيح API الخاصة بك
• POST /api/v1/api-keys — إنشاء مفتاح API جديد
• DELETE /api/v1/api-keys/{keyId} — حذف مفتاح API

مثال سريع

إليك مثال سريع لإنشاء mind والمحادثة معه:

# 1. Create a mind (keywords mode)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Marketing Expert",
    "description": "Expert in digital marketing strategies",
    "mode": "keywords",
    "type": "expert",
    "discipline": "Marketing",
    "keywords": ["SEO", "content marketing", "social media", "analytics"]
  }'

# Response: { "data": { "id": "mind-id", ... }, "processing": { "queued": true, ... } }

# 2. Create a mind from social profile (clone mode)
curl -X POST "https://getminds.ai/api/v1/minds" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Influencer Clone",
    "description": "AI trained on influencer social presence",
    "mode": "clone",
    "type": "creative",
    "discipline": "Social Media Marketing",
    "personaContext": "https://twitter.com/username"
  }'

# 3. Chat with the mind
curl -X POST "https://getminds.ai/api/v1/minds/mind-id/completion" \
  -H "Authorization: Bearer minds_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What are the top social media trends for 2025?"
      }
    ]
  }'

الخطوات التالية

• تعرّف على المصادقة
• استكشف Minds endpoints
• اقرأ عن إدارة المعرفة
• افهم Chat completions
• أنشئ Studies لاستطلاعات متعددة الـ minds
• راجع Latency والأداء
• اتصل عبر MCP Integration
• راجع Errors والحدود

حدود الباقات

يتوفر الوصول إلى API وMCP في الباقات المدفوعة المدعومة. عالج استجابات plan_limited و429 المنظمة بدلًا من تثبيت الحدود داخل التكامل. تظهر باقة Individual باسم "premium" في حمولات API.

تُنشأ القيم العامة الافتراضية أدناه من عقد حدود الباقات والوصول إلى الميزات نفسه المستخدم في المنتج. تتقدم التجاوزات الخاصة بالحساب أو بعقد Enterprise والظاهرة في المنتج على هذه القيم.

عرض الباقات

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

إذا كان لديك أسئلة أو تحتاج إلى دعم في API:

• راجع الدليل
• تواصل معنا عبر نموذج الملاحظات
• انضم إلى نقاشات مجتمعنا