مستندات توسعه‌دهندگان
شروع سریع با API چارتیکال
در چند مرحله API چارتیکال را به برنامه خود متصل کنید، اولین درخواست را ارسال و پاسخ دستیار هوش مصنوعی را دریافت کنید.
مراحل راه‌اندازی
ساخت کلید API
از پنل توسعه‌دهندگان یک کلید API ایجاد کنید. این کلید برای احراز هویت درخواست‌های شما استفاده می‌شود.
دریافت Slug دستیار
هر دستیار دارای یک Slug مخصوص به خود است که می توانید از طریق لینک زیر وارد بخش دستیارها شده و Slug مربوط به دستیار مد نظر خود را دریافت کنید
تنظیم URL پایه
تمام درخواست‌های API باید به URL پایه زیر ارسال شوند
BaseUrlhttps://api.chartical.com/api/v1ارسال اولین درخواست
نمونه زیر ساختار کلی ارسال پیام با JavaScript را نشان می‌دهد. درخواست را از سمت سرور برنامه خود ارسال کنید.
/chatconst headersList = {
"x-api-key": "YOUR API KEY",
"Content-Type": "application/json"
}
const bodyContent = JSON.stringify({
"slug":"education-and-research/parent-teacher",
"model":"smart",
"tools":{"webSearch":"never"},
"messages":[{
"role":"user",
"content":"Hello!"
}]
});
const response = await fetch("https://api.chartical.com/api/v1/chat", {
method: "POST",
body: bodyContent,
headers: headersList
});
const data = await response.text();
console.log(data);این کد نمونه است. نام فیلدهای درخواست، مسیر endpoint و ساختار پاسخ باید با پیاده‌سازی واقعی API تطبیق داده شوند.
بررسی پاسخ
پس از ارسال درخواست، وضعیت HTTP و بدنه پاسخ را بررسی کنید. در صورت موفقیت، داده برگشتی را مطابق ساختار واقعی پاسخ پردازش کنید.
"success": true,
"data": {
"requestId": "***",
"messages": {
"finish_reason": "stop",
"index": 0,
"message": {
"content": "Hello, I am your dedicated assistant. What are we going to do today?",
"role": "assistant",
"images": [],
"thinking_blocks": [],
"annotations": []
}
}
}
}ساختار صرفاً نمونه نمایشی است و لزوماً پاسخ واقعی API چارتیکال نیست.
نکات مهم
نکات مهم
برای یکپارچه‌سازی به راهنمایی نیاز دارید؟
اگر در ارسال درخواست، احراز هویت یا استفاده از دستیارها به مشکل برخوردید، از راهنماهای فنی استفاده کنید یا با پشتیبانی چارتیکال ارتباط بگیرید.