<!-- Generated from ar/blog/llms-txt-for-api-products/index.html. The canonical document is the HTML page. -->

- [ الرئيسية ](/ar/) 
/
- [ المدونة ](/ar/blog/) 
/
- llms.txt لمنتجات API            
# `llms.txt` لمنتجات تبدأ من API

يسأل المطورون المساعدات الذكية باستمرار عن المساعدة في واجهات API. ويقلل llms.txt المنسق جيداً من نقاط النهاية المتخيلة والمعلمات الخاطئة والأمثلة القديمة.

آخر تحديث: 22 أبريل 2026

في هذه الصفحة

- [ لماذا تستفيد منتجات API أكثر من غيرها ](#why-apis)
- [ مشكلة هلوسة API ](#hallucination-problem)
- [ ما ينبغي تضمينه ](#what-to-include)
- [ ما ينبغي استبعاده ](#what-to-exclude)
- [ قالب المثال ](#example-template)
- [ اعتبارات SDK وتعدد اللغات ](#sdk-considerations)
- [ الحفاظ على حداثته ](#maintenance)            
## لماذا تستفيد منتجات API أكثر من غيرها

تُعد المنتجات التي تتبع نهج API أولاً وأدوات المطورين من أكثر أنواع المواقع استعداداً للاستفادة
من llms.txt. ويسأل المطورون بانتظام مساعدات البرمجة الذكية عن واجهات API: كيفية تقسيم الصفحات،
وما حدود المعدل، وكيفية المصادقة، وكيفية معالجة خطأ محدد. هذه أسئلة دقيقة يمكن الإجابة عنها.
وعندما يملك الذكاء الاصطناعي توثيقاً صحيحاً، تكون الإجابات مفيدة. وعندما لا يملكه، فإنه يقدّر
الإجابة، وتسبب تقديرات API أخطاءً.

يمكن ضبط عميل أو سير عمل استرجاع متوافق لاستخدام llms.txt قائمة قراءة لـ API. وفي هذه الحالة
المضبوطة، يمكنك تتبع المستندات التي حُمّلت قبل الإجابة.

## مشكلة هلوسة API

تولّد نماذج لغة الذكاء الاصطناعي أحياناً تفاصيل API معقولة ظاهرياً لكنها خاطئة. ومن الأنماط
الشائعة:

- نقاط نهاية غير موجودة أو أُعيدت تسميتها. 
- معلمات من إصدار سابق لـ API. 
- حقول مخطط الاستجابة المتقادمة أو الخاطئة. 
- طرق مصادقة لا تدعمها API لديك. 
- حدود المعدل من فئة مختلفة أو نموذج أسعار قديم.   
تحدث هذه الأخطاء لأن بيانات تدريب النموذج أقدم بأشهر أو سنوات، ولأن واجهات API تتطور. وعندما
يجلب نظام استرجاع توثيقك الفعلي قبل الإجابة، فإنه يستخدم محتواك الحالي. ويساعد llms.txt بالإشارة
إلى صفحاتك المرجعية.

ملاحظة

llms-full.txt لمرجع API

إذا كان مرجع API لديك كبيراً جداً أو يتغير كثيراً، ففكّر أيضاً في نشر
llms-full.txt  مع تضمين محتوى الصفحة كاملاً.

## ما ينبغي تضمينه

بالنسبة إلى المنتجات التي تتبع نهج API أولاً، أعط الأولوية لهذه الأنواع من الصفحات:

- **مرجع API**، مرجع نقاط النهاية الكامل. وإذا كان طويلاً جداً، فاربط بالصفحة
العليا. 
- **دليل المصادقة**, وكيفية الحصول على بيانات الاعتماد وتمريرها في الطلبات. 
- **دليل البدء السريع**، أسرع مسار من الصفر إلى استدعاء API عامل. 
- **حدود المعدل والحصص**، مع حدود محددة حسب الفئة ونوع نقطة النهاية. 
- **مرجع الأخطاء**، ورموز الأخطاء ومعانيها. 
- **روابط توثيق SDK**, رابط واحد لكل SDK لغة مدعومة رسمياً. 
- **سجل التغييرات أو ملاحظات الإصدار**، ويساعد أنظمة الاسترجاع على فهم حالة API
الحالية. 
- **مرجع Webhooks**، وإذا كانت API لديك ترسل webhooks، فاربطه.   
## ما ينبغي استبعاده

- **توثيق محمي بالمصادقة**, وستفشل الصفحات خلف تسجيل الدخول عند جلبها من وكلاء
الذكاء الاصطناعي. 
- **صفحات داخلية أو تجريبية**، ولا تربط صفحات غير جاهزة للاستخدام العام. 
- **إصدارات API مهجورة**، واستبعد وثائق الإصدار القديم. 
- **صفحات الهبوط التسويقية**، وليست مفيدة للمطورين الذين يطرحون أسئلة تقنية. 
- **روابط منتدى المجتمع أو Slack**، لا تستطيع برامج زحف الذكاء الاصطناعي تحليل
المحتوى الديناميكي بصورة موثوقة.   
## قالب المثال

مثال كامل لمنتج API افتراضي. كيّفه مع بنية وثائقك.

```
# Acme API

> Acme provides a REST API for real-time inventory management. The API supports CRUD
> operations on products, locations, and stock adjustments, plus webhook notifications.
> Authentication uses API keys in the Authorization header.

## Core documentation

- [API reference](https://docs.acme.example/api/): complete endpoint reference.
- [Authentication](https://docs.acme.example/authentication/): API key setup and OAuth 2.0.
- [Quickstart](https://docs.acme.example/quickstart/): first API call in five minutes.
- [Rate limits](https://docs.acme.example/rate-limits/): limits by tier.
- [Errors](https://docs.acme.example/errors/): error codes and recommended handling.
- [Webhooks](https://docs.acme.example/webhooks/): event types and payload schema.

## SDKs

- [Python SDK](https://docs.acme.example/sdk/python/): official Python library.
- [Node.js SDK](https://docs.acme.example/sdk/node/): official Node.js library.
- [Go SDK](https://docs.acme.example/sdk/go/): official Go client.

## Optional

- [Changelog](https://docs.acme.example/changelog/): API version history and breaking changes.
- [Migration guides](https://docs.acme.example/migrations/): upgrading between major versions.
- [Status page](https://status.acme.example/): API uptime and incident history.
```

## اعتبارات SDK وتعدد اللغات

إذا كان لمنتجك SDK بلغات متعددة، فاربط توثيق كل SDK منفصلاً. ونظّمها في `## SDKs` القسم
واربط بالصفحة العليا لكل SDK بدلاً من كل صفحة فرعية.

## أبقِه محدثاً

- أضف مراجعة llms.txt إلى قائمة فحص إصدار API لديك. 
- عند إصدار إصدار رئيسي جديد من API، حدّث الروابط للإشارة إلى توثيق الإصدار الحالي. 
- عندما تهجّر صفحات التوثيق، أزل تلك الروابط أو استبدلها فوراً. 
- فكّر في إنشاء llms.txt تلقائياً من CMS التوثيق لديك إذا كان توثيقك يتحدث كثيراً.   
## واصل القراءة

- [llms.txt لمواقع التوثيق](/ar/blog/llms-txt-documentation-sites/), دليل أوسع لجميع
أنواع مواقع التوثيق. 
- [دليل llms-full.txt](/ar/llms-full-txt/)، مع تضمين المحتوى الكامل لأنظمة الاسترجاع. 
- [أمثلة حقيقية](/ar/examples/)، راجع ملفات llms.txt لدى Stripe وAnthropic. 
- [المولّد](/ar/generator/), أنشئ ملفك من نموذج.        
## المصادر

- [ llmstxt.org ](https://llmstxt.org/)
- [ Stripe llms.txt ](https://docs.stripe.com/llms.txt)
- [ توثيق Anthropic لملف llms.txt ](https://platform.claude.com/llms.txt)