الموارد · API Reference

API Reference

مرجع شامل لكل نقاط OpenQCore، مجمّعة حسب أسطح التشغيل والطبقات التنفيذية.

API Catalog

فهرس تنفيذي سريع. التفاصيل الفنية الكاملة متاحة في صفحات كل API.

Authentication

POST /auth/login

POST /auth/refresh

المصادقة، API keys، إدارة النطاق، والتحكم في الوصول.

[عرض توثيق Authentication]

مفاتيح API

POST /api-keys

GET /api-keys

POST /api-keys/{key_id}/revoke

POST /api-keys/{key_id}/disable

إنشاء مفاتيح API شخصية وعرضها وإلغاؤها وتعطيلها، وتُستخدم للمصادقة غير التفاعلية.

عرض مرجع مفاتيح API ←

Chat Runtime

GET /chat/health

POST /chat/completions

تنفيذ المحادثة الأساسي، البث، الحفظ، وضوابط التشغيل.

[عرض Chat API]

جلسات المحادثة والرسائل

POST /sessions

GET /sessions

GET /sessions/{session_id}/messages

PATCH /sessions/{session_id}

DELETE /sessions/{session_id}

GET /messages/{message_id}

PATCH /messages/{message_id}

GET /messages/{message_id}/history

POST /messages/{message_id}/undo

DELETE /messages/{message_id}

إنشاء جلسات المحادثة وعرضها وإعادة تسميتها وتثبيتها أو تمييزها بنجمة وحذفها؛ تعديل رسالة مع الاحتفاظ بسجل التعديلات، أو التراجع عن آخر تعديل، أو حذف رسالة.

عرض واجهة الجلسات والرسائل ←

Voice Runtime

POST /voice/chat

POST /voice/chat/meta

POST /voice/interrupt/{session_id}

WS /voice/ws

STT و LLM و TTS اللحظي، الإيقاف، والبث الصوتي.

[عرض Voice API]

Iris Multimodal

POST /iris/generate

POST /iris/video

POST /iris/ocr

POST /iris/verify

مسارات الصورة والفيديو و OCR والمهام متعددة الوسائط.

[عرض Iris API]

Knowledge

GET /console/knowledge

POST /console/knowledge

POST /console/knowledge/upload

POST /console/knowledge/ask

PATCH /console/knowledge/{id}

DELETE /console/knowledge/{id}

فهرسة المعرفة، الاسترجاع، والتنفيذ المعزز بالمعرفة.

[عرض Knowledge API]

الأرشيف

POST /archive/units

GET /archive/units

GET /archive/units/{unit_id}

PATCH /archive/units/{unit_id}

DELETE /archive/units/{unit_id}

إنشاء وحدات معرفية مؤرشفة وعرضها واسترجاعها وتعديلها وحذفها، مرتبطة بمستخدم أو مساحة عمل.

عرض واجهة الأرشيف ←

Runtime Headers

جدول سريع للهيدرز المطلوبة عبر المسارات.

Header	Required
`Authorization`	✅
`X-API-Key`	بديل عن Authorization
`X-Scope-Type`	✅
`X-Workspace-ID`	Workspace Only
`X-Agent-ID`	Optional

Response Codes

أكواد الاستجابة الشائعة في طبقات التشغيل.

Code	Meaning
200	Success
400	طلب غير صالح
401	Unauthorized
403	Forbidden
409	Lock Conflict
422	Validation Error
429	Rate Limited
503	Overloaded

Platform Statistics

لقطة سريعة عن سعة المنصة التشغيلية.

Endpoints

Runtime Surfaces

Provider Integrations

Unified

Output Contract

Dual

Streaming + Non-Streaming