مستندات توسعه‌دهندگان چارتیکال

قدرت هوش مصنوعی را به محصول خود اضافه کنید

با API چارتیکال، دستیارهای هوش مصنوعی را در نرم‌افزارها و سرویس‌های خود به کار بگیرید. مستندات ما به شما کمک می‌کند از اولین درخواست تا یکپارچه‌سازی کامل، مسیر توسعه را دنبال کنید.

مبتنی بر HTTPنمونه کد قابل استفادهمناسب توسعه‌دهندگان

درخواست API

ارسال پیام به دستیار

POST

POST /api/v1/chat

x-api-key: ••••••••

messages:[

{

role:"user"content:"Hello"

}

]

پاسخ دستیار

پاسخ هوش مصنوعی را دریافت کرده و در برنامه خود نمایش دهید.

قابلیت‌ها

با API چارتیکال چه کارهایی می‌توانید انجام دهید؟

زیرساخت هوش مصنوعی چارتیکال را به بخشی از محصول خود تبدیل کنید و از امکانات پنل توسعه‌دهندگان برای مدیریت استفاده از API بهره ببرید.

دستیارهای هوش مصنوعی
از دستیارهای تخصصی چارتیکال در نرم‌افزارها و سرویس‌های خود استفاده کنید.
یکپارچه‌سازی ساده
با استفاده از درخواست‌های HTTP، API را به بک‌اند یا برنامه خود متصل کنید.
مدیریت مصرف و هزینه
مصرف درخواست‌ها، توکن‌ها و هزینه‌های خود را از طریق پنل توسعه‌دهندگان بررسی کنید.

شروع سریع

اولین درخواست خود را ارسال کنید

برای شروع، به یک کلید API معتبر و شناسه‌های موردنیاز درخواست دسترسی داشته باشید. سپس درخواست خود را از محیط امن برنامه ارسال کنید.

۱

کلید API دریافت کنید

از بخش کلیدهای API در پنل توسعه‌دهندگان، کلید موردنیاز خود را ایجاد کنید و آن را در محیط امن برنامه نگه دارید.

مدیریت کلیدهای API
۲

درخواست را تنظیم کنید

آدرس پایه API، مسیر endpoint، کلید احراز هویت و بدنه درخواست را مطابق مرجع فنی تنظیم کنید.

۳

پاسخ را پردازش کنید

پاسخ سرور را بخوانید، خطاهای احتمالی را مدیریت کنید و نتیجه را در برنامه خود نمایش دهید.

نکته امنیتی

کلید محرمانه API را در کد فرانت‌اند، مرورگر یا مخزن عمومی قرار ندهید. درخواست‌های دارای کلید محرمانه را از سمت سرور برنامه خود ارسال کنید.

نمونه درخواست

Fetch API
javascript
const 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);

این نمونه برای نمایش ساختار کلی درخواست است. آدرس پایه، فیلدهای درخواست و ساختار پاسخ را با مشخصات واقعی API چارتیکال تطبیق دهید.

مستندات فنی

قدم بعدی؟

با توجه به مرحله‌ای که در توسعه قرار دارید، راهنمای مناسب را انتخاب کنید.

برای یکپارچه‌سازی به راهنمایی نیاز دارید؟

اگر در ارسال درخواست، احراز هویت یا استفاده از دستیارها به مشکل برخوردید، از راهنماهای فنی استفاده کنید یا با پشتیبانی چارتیکال ارتباط بگیرید.

ارتباط با پشتیبانی