> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# استدعاء أداة

> طلب استدعاء الأداة مع التحقق من النطاق، وتحديد المعدل، وإنشاء إيصال التدقيق

# استدعاء الأداة

`POST /v1/tools/{toolName}/invoke`

يطلب استدعاء أداة مسجلة نيابة عن وكيل آلي. تقوم المنصة بإجراء فحص متعدد الطبقات للتحكم في الوصول قبل منح الوصول:

1. **حالة الوكيل** -- يجب أن يكون الوكيل `"active"`
2. **فحص النطاق** -- يجب أن يمتلك الوكيل النطاق المطلوب للأداة
3. **حد المعدل** -- يجب ألا يتجاوز الوكيل حد المعدل لكل دقيقة للأداة
4. **بوابة الموافقة** -- إذا كانت الأداة تتطلب موافقة، فإن الاستجابة هي `pending_approval`؛ المعالج الحالي لا ينشئ طلب موافقة

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

> [!NOTE]
>
> تنفذ نقطة النهاية هذه **قرار التحكم في الوصول** وتسجل القرار. لا تقوم بتوكيل التنفيذ الفعلي للأداة. تطبيقك هو
> مسؤول عن استدعاء نقطة نهاية الأداة الأساسية بعد تلقي
> `"allowed"` الاستجابة.

### المصادقة

يتطلب رأس `X-API-Key` أو رمز Bearer JWT. يتم اشتقاق مساحة العمل من بيانات الاعتماد الموثقة؛ لا ترسل `X-Tenant-ID`.

### الاستجابة

**allowed** `boolean`

ما إذا كان الاستدعاء مصرحًا به. `true` إذا كانت جميع فحوصات التحكم في الوصول
تم تمريره.

**status** `string`

حالة الاستدعاء. أحد الخيارات التالية: `"allowed"`، `"denied"`، `"pending_approval"`.

**reason** `string`

شرح مقروء بشريًا عندما يتم رفض الاستدعاء أو يكون معلقًا. ليس
موجود عند السماح بذلك.

**receipt\_id** `string`

معرف إيصال فريد للاستدعاء، يربط بمسار التدقيق. فقط
موجود عندما يكون `status` هو `"allowed"`.

**requires\_approval** `boolean`

`true` عندما تتطلب الأداة موافقة بشرية. لا يتم وضع الاستدعاء تلقائيًا في قائمة الانتظار للموافقة.
موجود فقط عندما يكون `status` هو `"pending_approval"`.

### مثال: استدعاء مسموح به

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/tools/search.web/invoke \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
    "session_id": "maip-sess:a1b2c3d4:9f8e7d6c5b4a3210"
  }'
```

***

### تدفق التحكم في الوصول

```
POST /v1/tools/{name}/invoke
  |
  +-- Is agent active?
  |     No  --> { allowed: false, status: "denied", reason: "agent is not active" }
  |
  +-- Does agent have required scope?
  |     No  --> { allowed: false, status: "denied", reason: "agent lacks required scope: ..." }
  |
  +-- Is rate limit exceeded?
  |     Yes --> { allowed: false, status: "denied", reason: "rate limit exceeded" }
  |
  +-- Does tool require approval?
  |     Yes --> { allowed: false, status: "pending_approval", requires_approval: true }
  |
  +-- Create receipt + record invocation
        --> { allowed: true, status: "allowed", receipt_id: "..." }
```

### نمط التكامل

بعد تلقي استجابة `"allowed"`، قم بتنفيذ الأداة وسجل النتيجة اختياريًا:

```bash theme={null}
# 1. Request invocation authorization
RESPONSE=$(curl -s -X POST https://api.truthlocks.com/v1/tools/search.web/invoke \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{"agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH"}')

ALLOWED=$(echo "$RESPONSE" | jq -r '.allowed')
RECEIPT_ID=$(echo "$RESPONSE" | jq -r '.receipt_id')

# 2. Execute the tool only if explicitly authorized
if [ "$ALLOWED" = "true" ]; then
  RESULT=$(curl -s "https://serpapi.com/search?q=example&api_key=...")
  echo "Tool executed. Receipt: $RECEIPT_ID"
fi
```


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/tools/{toolName}/invoke
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/tools/{toolName}/invoke:
    post:
      tags:
        - Machine Identity
      summary: استدعاء أداة
      description: >-
        يتحقق من الوصول ويسجل قرار الاستدعاء. لا ينفذ الأداة. تتطلب الإيصالات
        الجديدة موقعًا مكونًا ومفتاح توقيع وكيل نشط صالح. لا ينشئ قرار
        pending_approval طلب موافقة؛ اطلب مراجعة مستقلة صراحةً عبر /v1/approvals
        وافرض النتيجة في تطبيقك.
      operationId: maip.tools.invoke
      parameters:
        - name: toolName
          in: path
          required: true
          schema:
            type: string
          description: اسم الأداة المسجل.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                agent_id:
                  type: string
                session_id:
                  type: string
                  description: جلسة نشطة للاستدعاء تحتها
                  format: uuid
              type: object
              required:
                - agent_id
      responses:
        '200':
          description: نتيجة استدعاء الأداة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipToolInvocationResult'
        '400':
          description: خطأ في التحقق أو عدم تطابق المخطط
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: الأداة أو الجلسة غير موجودة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: تجاوز حد المعدل
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipToolInvocationResult:
      type: object
      properties:
        result:
          type: object
          additionalProperties: true
        receipt_id:
          type: string
          format: uuid
        execution_ms:
          type: integer
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: رمز خطأ قابل للقراءة آليًا
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: رسالة خطأ مقروءة بشريًا
        http_status:
          type: integer
          description: رمز حالة HTTP
        retry_after_ms:
          type: integer
          description: عدد المللي ثانية للانتظار قبل إعادة المحاولة (لحدود المعدل)
        details:
          type: object
          description: سياق خطأ إضافي
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.