مستندات توسعه‌دهندگان

مرجع API برای اتصال ربات به محصول شما.

شروع سریع

در ۳ گام ربات را فراخوانی کن.

  1. ۱کلید API بساز
  2. ۲درخواست POST بفرست
  3. ۳پاسخ را نمایش بده
curl -X POST https://api.example.com/api/v1/public/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "${q}",
    "user_id": "customer-42"
  }'
شروع رایگان

مستندات

آدرس

POSThttps://api.example.com/api/v1/public/v1/chat

احراز هویت

کلید را در هدر Authorization یا X-API-Key بفرست.

Authorization: Bearer hy_live_xxxxxxxx
# or
X-API-Key: hy_live_xxxxxxxx

بدنه درخواست

messageمتن پیام کاربر
conversation_idادامه یک مکالمه (اختیاری)
user_idشناسه کاربر در سیستم شما (اختیاری)
streamفعال‌سازی پاسخ جریانی (اختیاری)
{
  "message": "ارسال به شیراز چند روزه است؟",
  "conversation_id": "optional",
  "user_id": "customer-42",
  "stream": false
}

پاسخ

{
  "conversation_id": "c_8f2a...",
  "message": {
    "id": "m_41d9...",
    "role": "assistant",
    "content": "ارسال به شیراز ۲ تا ۳ روز کاری ...",
    "citations": [
      { "document_id": "d_17", "title": "قوانین ارسال", "url": "https://...", "snippet": "...", "score": 0.82 }
    ],
    "feedback": null,
    "created_at": "2026-01-01T10:00:00Z"
  }
}

پاسخ جریانی

با stream=true پاسخ به‌صورت SSE برگردانده می‌شود.

محدودیت نرخ

۶۰ درخواست در دقیقه برای هر کلید. هدرهای X-RateLimit-* را بررسی کن.

کدهای خطا

401unauthorized
403forbidden
404not_found
412precondition_failed
422validation_error
429rate_limited