ابدأ مجانًا →

SDK وسطر الأوامر

مرجع واجهة API

كل مسار يستدعيه تطبيق أو وكيل أو مزوّد هوية: طريقة مصادقته، والنطاق الذي يحتاجه المفتاح، والحقول التي يأخذها، والإجابات التي يعطيها.

ملف OpenAPI

المرجع نفسه في ملف بصيغة OpenAPI 3.1، لمولّدات الشيفرة واختبارات العقد. ويُبنى من العقد الذي تطابقه اختبارات Azoth نفسها مع المسارات في الاتجاهين: فالمسار الغائب عنه، أو المسار الذي يسمّيه ولا وجود له، يُفشلها.

openapi.yaml

ملخصات المسارات وأسماء الحقول مكتوبة بالإنجليزية، هنا وفي الملف.

المصادقة

Authorization
Bearer <key>: مفتاح API لمساحة العمل من الإعدادات › الوصول — az_live_…، أو az_test_… في الخطة المجانية. ولا يصل المفتاح ذو النطاقات إلا إلى المسارات التي تغطيها نطاقاته.
X-Azoth-API-Key
<key>: المفتاح نفسه في ترويسة خاصة به. وكل مسار يقبل مفتاحًا يقبل الطريقتين.

قراءات لوحة التحكم نفسها — /api/v1/me وقراءات GreenOps — تتطلب جلسة مسجّلة، ولا تقبل مفتاحًا أبدًا. وتتطلب مسارات SCIM رمز SCIM الخاص بمساحة العمل (التزويد عبر SCIM).

الإجابات والأخطاء

تحمل إجابة الخطأ error، وهي جملة، وcode ثابتًا، وdoc_url يقود إلى مدخل الرمز في رموز الأخطاء؛ ويسمّي 400 أيضًا الحقل field الذي أخفق. ويجيب حدّ المعدّل بـ 429 مع retryAfterMs في الجسم وRetry-After في الترويسات. والمسار الذي لا يشغّل النشر وحدته يقول ذلك. يمكن إعادة محاولة استدعاء البوابة غير المتدفق (/api/v1/chat/completions، /api/v1/chat) بأمان مع ترويس Idempotency-Key: خلال الساعة، تتلقى إعادة محاولة استدعاءٍ أُجيب الإجابةَ الأولى نفسها — دون استدعاء ثانٍ للنموذج أو ختم ثانٍ أو إنفاق ثانٍ — متى سمحت سياسة بيانات مساحة العمل لـ Azoth بالاحتفاظ بها؛ وإلا أُبلغت إعادة المحاولة بذلك (idempotency_replay_unavailable) مع أثر الاستدعاء الأول.

المسارات

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

استدعاءات البوابة

استدعاء نموذج عبر البوابة المحكومة — وما يحيط بالاستدعاء: هل يحتاج إلى نموذج، والنموذج الذي يمكن لأول استدعاء استخدامه، واستئناف استدعاء معلّق، وطلب استثناء، والتحقق من الاستناد، وإيصالات خزنتك الخاصة.

كل مسارات هذا الجزء كاملةً

/api/v1/chat

/api/v1/infer

/api/v1/models

/api/v1/exceptions

/api/v1/grounding

/api/v1/vault

القياس عن بُعد والتحسين

الإبلاغ عن الاستدعاءات المُجراة خارج البوابة، واختيار نموذج لطلب، والبحث عن الإجابات المخزّنة مؤقتًا وتخزينها، والتحقق من دخول وكيل في حلقة، وضغط المحتوى الطويل، والاستعلام من سوق المزوّدين.

كل مسارات هذا الجزء كاملةً

/api/ingest

/api/arbiter

/api/cache

/api/loops

/api/v1/compress

/api/v1/reconstruct

/api/v1/marketplace

الإثبات

قراءة القرارات المختومة، وتصدير ملف التدقيق أو ملف قرار واحد، وجلب المفاتيح العامة التي تتحقق من الإيصالات، وقراءة أدلة Azoth Guard وحوادث مساحة العمل.

كل مسارات هذا الجزء كاملةً

/api/v1/journal

/api/v1/decisions

/api/proof

/api/v1/guard

/api/v1/incidents

الأنظمة والسياسات

التصريح بأنظمتك (حالات الاستخدام) وقراءتها، مع الاستدعاءات التي جرت خارج ما اعتُمد له أحدها؛ وقراءة الحزم التنظيمية وسياسة البيانات التي يطبّقها SDK.

كل مسارات هذا الجزء كاملةً

/api/v1/usecases

/api/v1/policy

/api/v1/governance

الاختبارات وتغييرات النماذج

إدارة مجموعات اختبارات الانحدار وتشغيلها، أو مقارنة نماذج عليها؛ وقراءة عمليات مجموعات المرجع التي تنتظر نظامك عند تغيّر نموذج، وإرسال نتائجها.

كل مسارات هذا الجزء كاملةً

/api/v1/regression

/api/v1/reference-sets

الوكلاء وMCP

قراءة الإنفاق والوفورات لكل وكيل، واستدعاء الأدوات عبر بوابة MCP المحكومة، وتشغيل أدوات القراءة الخاصة بالمساعد.

كل مسارات هذا الجزء كاملةً

/api/v1/agents

/api/v1/mcp

/api/v1/insights

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

قراءة آثار الاستخدام، وتقرير الإنفاق والوفورات، والميزانيات واستهلاكها، والبصمة التقديرية من الطاقة والكربون.

كل مسارات هذا الجزء كاملةً

/api/v1/usage

/api/v1/report

/api/v1/budgets

/api/v1/greenops

الخدمة والحساب

التحقق من أن الخدمة تعمل، ومعرفة الوحدات الجاهزة للإنتاج، وتصدير بيانات مساحة العمل، وقراءة حسابك الخاص أو محوه.

كل مسارات هذا الجزء كاملةً

/api/health

/api/v1/system

/api/v1/export

/api/v1/me

  • GET /api/v1/me — Your personal data (GDPR art. 15) — signed in, never an API key
  • DELETE /api/v1/me — Erase your account (GDPR art. 17) — signed in, never an API key

التزويد عبر SCIM

إنشاء المستخدمين والمجموعات وتحديثهم وإزالتهم من مزوّد هويتك، برمز SCIM الخاص بمساحة العمل.

كل مسارات هذا الجزء كاملةً

/api/scim/v2