مرجع واجهة API
الخدمة والحساب
التحقق من أن الخدمة تعمل، ومعرفة الوحدات الجاهزة للإنتاج، وتصدير بيانات مساحة العمل، وقراءة حسابك الخاص أو محوه.
ملخصات المسارات وأسماء الحقول مكتوبة بالإنجليزية، هنا وفي الملف.
/api/health
GET /api/health
Health check, for uptime monitors
المصادقة
لا شيء: عام
الإجابات
200 · 429 · 503/api/v1/system
GET /api/v1/system/modules
Which modules are production-grade, beta or experimental
المصادقة
مفتاح API
نطاق المفتاح
usage:readالمعاملات
maturityالإجابات
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/export
GET /api/v1/export
The workspace's data, for portability (GDPR art. 20)
المصادقة
مفتاح API
نطاق المفتاح
journal:readالمعاملات
format · tables · offset · limitالإجابات
200 · 401 api_key_missing, api_key_invalid · 403 api_key_role_denied, api_key_scope_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailable/api/v1/me
GET /api/v1/me
Your personal data (GDPR art. 15) — signed in, never an API key
المصادقة
جلسة مسجّلة (لوحة التحكم)
المعاملات
cursorالإجابات
200 · 400 validation_failed · 401 session_required, session_expired, mfa_challenge_required · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/me
Erase your account (GDPR art. 17) — signed in, never an API key
المصادقة
جلسة مسجّلة (لوحة التحكم)
الإجابات
200 · 401 session_required, session_expired, mfa_challenge_required · 409 legal_hold_active · 429 · 500 internal_error · 502 billing_cancel_failed · 503 billing_cancel_failed, service_unavailable