Messages API
مرجع درخواست و پاسخ Claude با مثالهای curl، Python و JavaScript.
آدرس و احراز هویت
HTTP
POST https://efars.com/claude/v1/messages
x-api-key: YOUR_EFARS_API_KEY
anthropic-version: 2023-06-01
Content-Type: application/jsonنمونهها آموزشیاند و حاصل اجرای زنده نیستند. YOUR_EFARS_API_KEY و نامهای ختمشونده به MODEL_NAME جاینگهدارند؛ پیش از اجرا، کلید ایفارس و مدل مجاز حساب خود را جایگزین کنید. مقادیر شناسه و مصرف در پاسخهای نمونه، گزارش مصرف واقعی نیستند.
پارامترهای درخواست
| پارامتر | نوع و الزام | توضیح |
|---|---|---|
| model | string · الزامی | شناسه مدل Claude مجاز برای کلید و حساب شما. |
| max_tokens | integer · الزامی | سقف توکن خروجی؛ متناسب با مدل و بودجه درخواست انتخاب کنید. |
| messages | array · الزامی | پیامهای user و assistant؛ content میتواند متن یا آرایه بلوکها باشد. |
| system | string / array · اختیاری | دستور سیستمی در سطح اصلی بدنه، جدا از messages. |
| stream | boolean · اختیاری | با true رویدادهای بومی Messages دریافت میشوند. |
| temperature / top_p / top_k | number · اختیاری | پارامترهای نمونهگیری با توجه به قابلیت و محدودیت مدل. |
| tools / tool_choice | array / object · اختیاری | تعریف ابزار و سیاست انتخاب؛ tool_use با متن معمولی تفاوت دارد. |
ساختار درخواست
JSON
{
"model": "CLAUDE_MODEL_NAME",
"max_tokens": 256,
"messages": [
{
"role": "user",
"content": "سلام! لطفاً خودت را معرفی کن."
}
],
"stream": false
}نمونه کد اتصال
این کدها برای محیط امن سمت سرور هستند. درخواست مصرفی را فقط پس از جایگزینی مدل و کلید و بررسی دسترسی و تعرفه ارسال کنید.
curl
# مدل جاینگهدار را با مدل مجاز حساب خود جایگزین کنید.
curl --fail-with-body 'https://efars.com/claude/v1/messages' \
-H "x-api-key: ${EFARS_API_KEY}" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
--data '{
"model": "CLAUDE_MODEL_NAME",
"max_tokens": 256,
"messages": [
{
"role": "user",
"content": "سلام! لطفاً خودت را معرفی کن."
}
],
"stream": false
}'ساختار پاسخ
JSON
{
"id": "msg-example",
"type": "message",
"role": "assistant",
"model": "CLAUDE_MODEL_NAME",
"content": [
{
"type": "text",
"text": "سلام! من Claude، دستیار هوش مصنوعی Anthropic هستم. میتوانم در برنامهنویسی، تحلیل اطلاعات، نگارش و حل مسائل به شما کمک کنم."
}
],
"stop_reason": "end_turn",
"usage": {
"input_tokens": 0,
"output_tokens": 0
}
}مسیر استخراج متن: content[].text (type = text). این نمونه فقط پاسخ متنی را نمایش میدهد؛ نوع بلوکها و علت پایان را پیش از خواندن متن بررسی کنید.
همه بلوکهای content الزاماً متن نیستند. stop_reason مانند end_turn، max_tokens یا tool_use را بررسی کنید؛ وجود tool_use به معنای پایان اجرای ابزار در برنامه شما نیست.