صفحات نقاط النهاية في قسم مرجع API هذا (مخططات الطلب والرد وساحة التجربة) تُولَّد من مخطط OpenAPI ومتاحة بالإنجليزية فقط. الأدلة بهذه اللغة تغطي السلوك نفسه.
عنوان الأساس
كل نقاط النهاية تقع تحتhttps://api.chattler.ai/v1. لا يُخدَم إلا HTTPS.
المصادقة
كل طلب يحتاج إلى مفتاح API في الترويسةAuthorization بنظام Bearer. يُنشأ المفتاح في تطبيق Chattler؛ راجع احصل على مفتاح API.
read-only لنقطتي نهاية GET، وfull لهما بالإضافة إلى نقطتي نهاية الدردشة POST.
الاصطلاحات
- أجسام الطلب والرد بصيغة JSON (
Content-Type: application/json)، باستثناء نقطة نهاية الرد المتدفق التي تجيب بـtext/event-stream. - نقطتا نهاية الدردشة كلتاهما تتطلبان ترويسة
Idempotency-Key، من 1-255 حرفًا، فريدة لكل طلب منطقي. راجع التكرار الآمن. - كل رد يحمل
X-Request-ID. ترويسات حد المعدلX-RateLimit-LimitوX-RateLimit-RemainingوX-RateLimit-Resetموجودة في ردود JSON200وفي429؛ أما تدفق SSE وردود الأخطاء الأخرى فلا تحملها. راجع حدود المعدل. - كل إخفاق هو
{"error": {"code", "message", "request_id"}}. راجع الأخطاء. - القوائم هي
{"data": [...], "next_cursor": "..." | null}؛limitمن 1-100، والافتراضي 20. - الطوابع الزمنية بصيغة ISO-8601 بتوقيت UTC. تقبل المرشّحات قيمًا بمنطقة زمنية أو من دونها (القيمة بلا منطقة زمنية تُقرأ على أنها UTC)؛
date_toغير شامل.
جرّبها في ساحة التجربة
لصفحات نقاط النهاية ساحة تجربة. الصق مفتاحًا حقيقيًا كرمز bearer واستخدم معرّف الوكيل الذي ينتمي إليه المفتاح؛ تذهب الطلبات مباشرة إلىhttps://api.chattler.ai وتُفوتر كأي استدعاء آخر.