profound-logoProfound CMS
⌘K
Admin
Theme
Docsبرنامج تعليميBlogPhilosophy
Docsبرنامج تعليميBlogPhilosophy

Hybrid

التوجيه البارامتريTypes of Componentsإس إس إيInstall Profound CMS as a proxyالبرمجة النصية في منشئ القوالبProject Scaffoldingمكتبة الوسائط

بلا رأس

البدء السريعJSON و Claude CodeComponent Zod Pull

واجهة برمجة تطبيقات REST

نظرة عامة على واجهة RESTgetربط موقع الويب بواجهة برمجة التطبيقاتgetالحصول على المساراتgetالحصول على مسارgetالحصول على الكتلgetجلب الكتل مع ذاكرة CEL المؤقتةgetGET /blocks/generatedgetالحصول على المكوناتgetGET /components/{name}getالحصول على اسم مخطط مجموعة البياناتgetالحصول على تغييرات المحتوى (SSE)patchPATCH /dataset/{schema_name}postترجمة المنشورpatchPATCH /translationsgetالحصول على الاستخدامpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

الحصول على الاستخدام

الإبلاغ عن الاستخدام التقديري لرموز الترجمة الخاصة بمنظمة واستخدام البايت في قاعدة البيانات لكل جدول.

أبلغ عن استخدام رموز الترجمة التقديري لمنظمة WorkOS (حسب اللغة) واستخدام البايت في قاعدة البيانات لكل جدول.

المصادقة: رمز JWT بنوع Bearer (WorkOS).

معلمات الاستعلام

المعاملالنوعمطلوبملاحظات
orgIduuidنعممنظمة WorkOS المطلوب إعداد تقرير عنها.

الاستجابة

{
  "orgId": "...",
  "translations": {
    "translations": 120,
    "estimatedPromptTokens": 45000,
    "estimatedCompletionTokens": 42000,
    "estimatedTotalTokens": 87000,
    "byLanguage": [
      {
        "language": "fr",
        "translations": 40,
        "estimated_prompt_tokens": 15000,
        "estimated_completion_tokens": 14000,
        "estimated_total_tokens": 29000
      }
    ],
    "note": "..."
  },
  "database": {
    "totalBytes": 1048576,
    "totalHuman": "1.0 MB",
    "byTable": [ { "table": "documents", "rows": 42, "bytes": 500000 } ],
    "note": "..."
  }
}

تعداد الرموز تقديري (استدلال بحوالي 4 أحرف لكل رمز بالإضافة إلى بدل ثابت لموجه النظام في كل استدعاء)، وهو ليس الاستخدام المفوتر من المزود. يتم جمع استخدام قاعدة البيانات عبر دالة pg_column_size لكل جدول مملوك؛ ولا تُحتسب الملفات الثنائية للصور المخزنة في تخزين الكائنات. لاحظ غرابة التسلسُل (serde): داخل byLanguage تكون مفاتيح الرموز بصيغة snake_case (مثل estimated_prompt_tokens، إلخ) بينما يستخدم الكائن الأب صيغة camelCase.

مثال

curl '{CMS_API_URL}/usage?orgId=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>'

الأخطاء

  • 400 — orgId مفقود أو غير صالح
  • 401 — رمز JWT مفقود أو غير صالح
  • 500 — فشل في الاستعلام
Continue Reading
Previous‹PATCH /translationsNextPOST /csv›