Open API

الاستعلام عن الرصيد باستخدام مفتاح API

استعلم عن الحصة المتبقية للمفتاح الحالي باستخدام مفتاح API من نوع sk-: يعيد GET /v1/user/balance الحقول is_active / balance / unit، ويعيد GET /v1/credits الحقلين total_credits / total_usage بأسلوب OpenRouter. متوافق مع الاستعلام الدوري من عملاء الطرف الثالث مثل cc-switch.

باستخدام مفتاح API يبدأ بـ sk- يمكنك الاستعلام مباشرةً عن الحصة المتبقية لهذا المفتاح وحالة توفره. هذا مناسب لعملاء الطرف الثالث التي تعرض الرصيد في واجهتها، أو للسكربتات التي تراقب الرصيد.

هذه الواجهات للقراءة فقط: لا تتم فوترتها ولا تستهلك حصة. تتحقق المصادقة من المفتاح نفسه فقط، لذا يمكنك قراءة الحصة المتبقية حتى عندما تكون الحصة مستنفدة وتُرفض طلبات العمل (في هذه الحالة تكون is_active هي false).

1. نظرة عامة على الواجهات

الواجهةتنسيق العميل الذي تدعمهما تعيده
GET /v1/user/balanceقالب الرصيد العام في cc-switchis_active / balance / unit، بالإضافة إلى used / total عندما يكون للمفتاح حصة إجمالية
GET /user/balanceمثل السابق، لعنوان Base URL بدون /v1مطابق تمامًا للسطر أعلاه
GET /v1/creditsبأسلوب OpenRouterdata.total_credits / data.total_usage
العنصرالقيمة
Base URLhttps://api.lmuai.com
المصادقةAuthorization: Bearer <sk-...>
تنسيق الاستجابةJSON
هل يلزم تسجيل الدخول؟لا، مفتاح API يكفي

/user/balance هو اسم بديل لـ /v1/user/balance (يُستخدم عندما يُضبط Base URL لدى العميل بدون /v1). أما /v1/credits فليست له أي نسخة على المسار الجذري، ويجب تضمين /v1.

2. أي رصيد يتم إعادته

balance ليس بالضرورة رصيد محفظة الحساب، بل هو الحصة المتبقية المتاحة فعليًا للمفتاح الحالي، ويُحدد بالترتيب التالي:

الترتيبحالة المفتاحمعنى balance
1للمفتاح حصة إجمالية خاصة بهالحصة المتبقية لهذا المفتاح (total - used)
2المفتاح ينتمي إلى مجموعة اشتراكالحصة المتبقية للاشتراك (unit تكون requests عند الاحتساب بالطلب)
3لا ينطبق أي مما سبقرصيد محفظة الحساب

كما يشير is_active إلى ما إذا كان المفتاح قابلًا للاستخدام الآن في طلبات العمل: يكون true عندما يكون المفتاح نشطًا وغير منتهي الصلاحية ولم تُستنفد حصته الإجمالية؛ ويكون أيضًا false عندما ينتمي المفتاح إلى مجموعة اشتراك بلا اشتراك سارٍ.

3. GET /v1/user/balance

GET /v1/user/balance HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

الاستجابة — وضع رصيد المحفظة (المفتاح بلا حصة ولا ينتمي إلى مجموعة اشتراك):

{
  "is_active": true,
  "balance": 1575.13,
  "unit": "USD"
}

الاستجابة — للمفتاح حصة إجمالية (في هذه الحالة يُعاد أيضًا used و total):

{
  "is_active": true,
  "balance": 6,
  "unit": "USD",
  "used": 4,
  "total": 10
}

الاستجابة — مجموعة اشتراك بالاحتساب حسب الطلب:

{
  "is_active": true,
  "balance": 842,
  "unit": "requests"
}

حقول الاستجابة

الحقلالنوعالوصف
is_activeboolما إذا كان المفتاح قابلًا للاستخدام الآن في طلبات العمل
balancenumberالحصة المتبقية؛ راجع unit لمعرفة الوحدة
unitstringUSD (الافتراضي)، أو requests لمجموعات الاشتراك المحتسبة حسب الطلب
usednumberيظهر فقط عندما يكون للمفتاح حصة إجمالية: الحصة المستخدمة من هذا المفتاح
totalnumberيظهر فقط عندما يكون للمفتاح حصة إجمالية: الحصة الإجمالية لهذا المفتاح

used / total لهما قيم ذات معنى في وضع الحصة الخاصة بالمفتاح فقط. لا يعيد وضعا رصيد المحفظة والاشتراك هذين الحقلين — اعتمد على balance ولا تستنتجه من total - used.

4. GET /v1/credits

تنسيق رصيد بأسلوب OpenRouter؛ تعرض العملاء الحصة المتبقية على أنها total_credits - total_usage.

GET /v1/credits HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

الاستجابة:

{
  "data": {
    "total_credits": 20,
    "total_usage": 4
  }
}
الحقلالنوعالوصف
data.total_creditsnumberالمستخدم + المتبقي، بحيث يساوي total_credits - total_usage الحصة المتبقية تمامًا
data.total_usagenumberالحصة المستخدمة

total_credits قيمة مركّبة من «المستخدم + المتبقي» وليست القيمة الحرفية لحد الحصة. في وضع رصيد المحفظة تكون total_usage هي 0 ويساوي total_credits الرصيد؛ وعند استنفاد الحصة تُقيَّد الحصة المتبقية عند 0، لذا يساوي total_credits في هذه الحالة الكمية المستخدمة.

5. الضبط في عملاء الطرف الثالث

العميل / السيناريوكيفية الضبط
قالب الرصيد العام في cc-switchيعمل Base URL ‏https://api.lmuai.com (بدون /v1) أو https://api.lmuai.com/v1 (مع /v1) على حد سواء
عملاء متوافقون مع OpenRouter (Kelivo وRikkaHub وغيرها)Base URL ‏https://api.lmuai.com/v1؛ وسيطلب العميل /v1/credits
سكربت خاص بكاستدعِ /v1/user/balance مباشرةً؛ حقوله أسهل في القراءة
curl -s https://api.lmuai.com/v1/user/balance \
  -H "Authorization: Bearer sk-xxxxxxxx"

6. استجابات الخطأ

يستخدم الاستعلام عن الرصيد مصادقة مفتاح API القياسية في البوابة، لذا تُعاد الأخطاء بالتنسيق نفسه المستخدم في استدعاءات API الأخرى. عندما لا يتضمن الطلب مفتاحًا:

{
  "code": "API_KEY_REQUIRED",
  "message": "API key is required in Authorization header (Bearer scheme), x-api-key header, or x-goog-api-key header"
}
رمز الحالةcodeالسيناريو
200—استجابة طبيعية؛ كما تعيد الحصة المستنفدة أو المفتاح منتهي الصلاحية أو الاشتراك المفقود 200، مع is_active: false للدلالة على أن المفتاح غير قابل للاستخدام
401API_KEY_REQUIREDلا يتضمن الطلب مفتاح API
401INVALID_API_KEYالمفتاح غير موجود أو بتنسيق غير صحيح
401API_KEY_DISABLEDتم تعطيل المفتاح
403ACCESS_DENIEDللمفتاح قائمة IP مسموح بها / محظورة، وعنوان IP الحالي غير مسموح به

للاطلاع على الأخطاء العامة، راجع رموز الأخطاء.

7. الفرق عن «تصدير تفاصيل الاستخدام»

واجهات الرصيد في هذه الصفحةتصدير تفاصيل الاستخدام
المصادقةمفتاح API من نوع sk-الحساب وكلمة المرور مقابل JWT
مستوى التفصيلالحصة المتبقية للمفتاح الحاليتفاصيل لكل طلب على مستوى الحساب
الاستخدامعرض الرصيد في العميل، مراقبة الرصيدتصدير الفواتير، المطابقة، التحميل إلى BI

تقع GET /v1/usage بين الاثنين: فهي تقبل أيضًا مفتاح sk- وتعيد إحصاءات استخدام اليوم والاستخدام التراكمي ومعلومات الحصة للمفتاح الحالي، بحقول أكثر تفصيلًا.

آخر تحديث:

京ICP备2020034311号-7

تصدير تفاصيل الاستخدام

دليل تصدير استخدام LMU AI: سجّل الدخول للحصول على JWT، ثم استدعِ /api/v1/usage مع الترقيم والنطاق الزمني وتصفية النموذج، مع أمثلة بثلاث لغات.

تسجيل الدخول باستخدام LMU AI

أضف زر "تسجيل الدخول باستخدام LMU AI" إلى موقعك أو تطبيقك: وجّه المستخدم إلى صفحة التفويض، وتحقّق من state عند الاستدعاء الراجع، ثم استبدل التذكرة بهوية المستخدم على خادمك باستخدام client_secret. يغطي هذا الدليل التدفق ونقاط النهاية وحقول المستخدم ومتطلبات الأمان ونماذج الشيفرة، إضافةً إلى موجّه جاهز تسلّمه مباشرةً لمساعد برمجة يعمل بالذكاء الاصطناعي.

في هذه الصفحة

1. نظرة عامة على الواجهات2. أي رصيد يتم إعادته3. GET /v1/user/balanceحقول الاستجابة4. GET /v1/credits5. الضبط في عملاء الطرف الثالث6. استجابات الخطأ7. الفرق عن «تصدير تفاصيل الاستخدام»