البدء السريع للمطورين

واجهة API لتتبع الاستخدام والتكاملات

ابدأ بمشروع واحد وحدث واحد. أضف الرؤية حيث يعمل سير عملك بالفعل.

مشروع واحد. سياق للقراءة فقط.

أدخل إشاراتك في المحادثة.

يقرأ الاتصالان استخدامك المرصود وسلامة الأتمتة وتقديرات رسوم العملاء الداخلية. أنشئ أولًا مفتاح قراءة مخصصًا للمشروع. لا حاجة إلى مفاتيح API للمزودين.

إضافة Codex المحلية

تنزيل الإضافة المحلية

يتضمن التنزيل INSTALL.md. بعد فك الضغط، شغّل npm ci --prefix server من ذلك المجلد. يستخدم المثال أدناه تخطيط مصدر التطبيق الكامل.

استخدم المرفق plugin/ حزمة المصدر. ثبّت تبعيات خادمها، ثم سجّل الحزمة عبر آلية الإضافات المحلية المدعومة في مضيف Codex لديك.

npm ci --prefix plugin/server

# In your MCP host's secure environment:
TRACEWELL_URL=https://tracewell.bhsoftwareproductions.com
TRACEWELL_READ_KEY=YOUR_PROJECT_READ_KEY

تُعرّف الحزمة خادم stdio محليًا في plugin/mcp.json. تفاصيل الإعداد مضمّنة في docs/PLUGIN.md. إتاحة المصدر لا تعني أن الإضافة مثبتة في مضيفك.

ChatGPT أو مضيف MCP متوافق

أضف اتصال MCP مخصصًا باستخدام نقطة النهاية المستضافة ومصادقة OAuth. راجع صفحة موافقة Tracewell وفوّض مفتاح قراءة مخصصًا للمشروع فيها؛ لا تلصق أسرار المزود أو مفاتيح القراءة في محادثة.

نقطة نهاية MCP المستضافةhttps://tracewell.bhsoftwareproductions.com/mcp

يجب أن يدعم المضيف والحساب والمسؤول اتصالات MCP المخصصة. يجب على المالك إعداد أصل OAuth المستضاف والتخزين الدائم. لا تتحقق هذه الصفحة من وجود اتصال مثبت.

فتح دليل إعداد ChatGPT الرسمي

البيانات الوصفية التي ترسلها فقط.

JavaScript SDK · Python SDK

لا تكتشف هذه الأدوات حسابات المزودين أو اشتراكات المحادثة أو كل محادثة. لربط مشروع آخر، استخدم مفتاح قراءة مخصصًا واتصالًا منفصلين.

إنشاء مفتاح قراءة للمشروع

إنشاء مشروع

افتح مساحة العمل واختر العملاء والمشاريع وحدّد اسمًا للعمل وميزانية شهرية بالدولار الأمريكي. استخدم وضع مساحة العمل الحقيقية فقط عند إعداد المصادقة وAPI.

فتح المشاريع ←

إصدار مفتاح محدد النطاق

أنشئ مفتاح استيعاب لذلك المشروع. انسخ سره مرة واحدة واحفظه على الخادم. لا تضعه أبدًا في شيفرة المتصفح ولا ترسل بيانات اعتماد مزودك إلى Tracewell.

إرسال بيانات الاستخدام الوصفية

curl https://YOUR_HOST/api/v1/usage \
  -H 'Authorization: Bearer YOUR_PROJECT_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"eventId":"unique-event-id","provider":"custom",
       "model":"my-model","costUsd":0.042}'

استخدم eventId فريدًا وثابتًا لإعادة المحاولة بأمان. قدّم costUsd أو كلًا من inputRatePerMillion وoutputRatePerMillion مع أعداد الرموز. دون تسعير صريح تبقى التكلفة مجهولة. يُدعم أي اسم مزود أو نموذج.

الإبلاغ عن النتائج

POST /api/v1/runs
{
  "eventId": "unique-run-id",
  "automationId": "YOUR_AUTOMATION_ID",
  "status": "success",
  "recordsProcessed": 12,
  "durationMs": 3400
}

أنشئ أتمتة أولًا. يُقيّم التشغيل المفقود بعد الفاصل المتوقع مضافًا إليه خمس دقائق. تنشئ النتائج الفاشلة أو غير الكافية تنبيهات داخل التطبيق. التنبيهات للإعلام ولا توقف أحمال العمل المصدر.

أضف السياق إلى Codex

استخدم دليل بدء الاتصال في المربع أعلاه لإضافة Codex المحلية أو نقطة MCP المستضافة مع OAuth. يتيح كلاهما ملخصات المشروع والاستخدام ونتائج الأتمتة وتقديرات رسوم العملاء الداخلية عبر وصول قراءة مخصص للمشروع. إعداد المضيف والتفويض صريحان.

تقرأ فقط الأحداث التي ربطتها بأدوات الرصد. لا تكتشف اشتراكات المحادثة، ولا تفحص كل محادثات Codex أو ChatGPT، ولا تستنتج التكاليف من فوترة الحساب. لقياس استدعاء API، أرسل بياناته الوصفية عبر نقطة الاستيعاب. افصل أسرار المزود عن مفاتيح Tracewell.

إنشاء مفتاح مشروع للقراءة فقط ←

قلّل حجم الحمولات

تُقبل فقط حقول البيانات الوصفية الموثّقة. تُرفض المطالبات والإجابات وأسرار المزود والحقول العشوائية. الحد الأقصى لطلبات JSON هو 16 KB. تُحدّد معرّفات الأحداث حسب المشروع ونوع الحدث.