التوثيق

curl https://api.mindlabsa.com/v1/chat/completions \  -H "Authorization: Bearer $QIRNAS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "model": "qirnas",    "messages": [{ "role": "user", "content": "اقترح ثلاثة أسماء لمقهى في جدة." }],    "temperature": 0.7,    "top_p": 0.9,    "max_tokens": 512,    "stop": ["###"],    "seed": 7,    "user": "u_8f14e45fceea167a"  }'

• أثناء تشغيل النموذج (قد يستغرق تشغيل وحدة GPU من السكون دقائق) ترسل البوابة سطر تعليق : keep-alive كل 15 ثانية — تجاهل كل سطر يبدأ بـ :.
• أرسل stream_options: { "include_usage": true } ليحمل آخر مقطع قبل [DONE] الاستهلاك، بقائمة choices فارغة.
• الفشل قبل بدء البث خطأ HTTP عادي. أما بعده فيصل حدث خطأ واحد يحمل كائن error نفسه (مع request_id)، ثم data: [DONE] — انظر رموز الأخطاء.

: keep-alivedata: {"id":"chatcmpl-5b2d…","object":"chat.completion.chunk","model":"qirnas","choices":[{"index":0,"delta":{"content":"أهلاً"},"finish_reason":null}]}data: {"id":"chatcmpl-5b2d…","object":"chat.completion.chunk","model":"qirnas","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}data: {"id":"chatcmpl-5b2d…","object":"chat.completion.chunk","model":"qirnas","choices":[],"usage":{"prompt_tokens":21,"completion_tokens":4,"total_tokens":25}}data: [DONE]

// Node 18+ — read the stream, skip keep-alive comments, surface in-band errors.async function streamChat(body) {  const res = await fetch("https://api.mindlabsa.com/v1/chat/completions", {    method: "POST",    headers: {      Authorization: `Bearer ${process.env.QIRNAS_API_KEY}`,      "Content-Type": "application/json",    },    body: JSON.stringify({ ...body, stream: true, stream_options: { include_usage: true } }),  });  if (!res.ok) throw new Error((await res.json()).error.code); // failed before streaming  const reader = res.body.pipeThrough(new TextDecoderStream()).getReader();  let buffer = "";  for (;;) {    const { value, done } = await reader.read();    if (done) return;    buffer += value;    let end;    while ((end = buffer.indexOf("\n\n")) >= 0) {      const event = buffer.slice(0, end);      buffer = buffer.slice(end + 2);      if (event.startsWith(":")) continue; // ": keep-alive" while the model starts      const data = event.slice("data: ".length);      if (data === "[DONE]") return;      const chunk = JSON.parse(data);      if (chunk.error) throw new Error(`${chunk.error.code}: ${chunk.error.message}`);      if (chunk.usage) console.log("\n", chunk.usage);      process.stdout.write(chunk.choices[0]?.delta?.content ?? "");    }  }}

1. اعرض الدوال في tools (واختيارياً tool_choice).
2. حين يستدعي النموذج دالة يكون finish_reason هو tool_calls، وتحمل message.tool_calls اسم الدالة ومعاملاتها بصيغة JSON نصية.
3. نفّذ الدوال، ثم أضف رسالة المساعد ورسالة role: "tool" لكل استدعاء (مع tool_call_id)، واطلب من جديد.

في البث تصل الاستدعاءات أجزاءً في delta.tool_calls — اجمع الأجزاء التي تشترك في index.

// 1. Offer a tool{  "model": "qirnas",  "messages": [{ "role": "user", "content": "كم درجة الحرارة في الرياض الآن؟" }],  "tools": [{    "type": "function",    "function": {      "name": "get_weather",      "description": "Current weather for a city",      "parameters": {        "type": "object",        "properties": { "city": { "type": "string" } },        "required": ["city"]      }    }  }]}// 2. The model calls it: finish_reason is "tool_calls""message": {  "role": "assistant",  "content": null,  "tool_calls": [{    "id": "call_abc123",    "type": "function",    "function": { "name": "get_weather", "arguments": "{\"city\":\"الرياض\"}" }  }]}// 3. Run it, append both messages, and call again with the same tools"messages": [  { "role": "user", "content": "كم درجة الحرارة في الرياض الآن؟" },  { "role": "assistant", "content": null, "tool_calls": [/* as received */] },  { "role": "tool", "tool_call_id": "call_abc123", "content": "{\"temp_c\":41}" }]

القائمة لكل مفتاح على حدة: تسرد بالضبط النماذج التي يحق لهذا المفتاح استدعاؤها، مع خفض max_output_tokens وdefault_max_tokens إلى سقف مخرجات المفتاح إن كان له سقف. qirnas اسم مستعار دائم للنموذج الافتراضي، ويتصدّر القائمة بحقول ذلك النموذج حين يحق لمفتاحك استدعاؤه. أرسله في model، أو احذف model، ليجيب النموذج الافتراضي. يُحتسب هذا الطلب ضمن حد معدل حسابك.

Deprecation: @1790467200Link: <https://developer.mindlabsa.com/changelog>; rel="deprecation"; type="text/html"

curl https://api.mindlabsa.com/v1/models \  -H "Authorization: Bearer $QIRNAS_API_KEY"

{  "object": "list",  "data": [    {      "id": "qirnas",      "object": "model",      "created": 1782982800,      "owned_by": "mindlab",      "provider": "mindlab",      "self_hosted": true,      "upstream_revision": null,      "context_window": 16384,      "max_output_tokens": 8192,      "default_max_tokens": 3072,      "capabilities": ["tools", "streaming"],      "status": "on"    },    // the default model under its own id, with the same fields    { "id": "qirnas-v0", "object": "model", /* … */ "status": "on" }  ]}

بالنسبة للنموذج: الرد 403 model_not_permitted يعني أن النموذج ظاهر لمفتاحك لكن المفتاح لا يملك الإذن به، أما 404 model_not_found فيعني أنه لا يحق لمفتاحك معرفته أصلاً. انظر رموز الأخطاء وحدود المعدل.

• أرسل معرّفك في x-request-id لتتطابق سجلاتك مع سجلاتنا: من 1 إلى 128 حرفاً من A-Z a-z 0-9 . _ : - (النمط ^[A-Za-z0-9._:-]{1,128}$). أي قيمة أخرى تُستبدل بمعرّف مولَّد.
• يكرّره غلاف الخطأ وحدث الخطأ أثناء البث في الحقل request_id.
• أرفقه عند التواصل مع الدعم لنتتبّع الطلب في سجلاتنا.

curl -si https://api.mindlabsa.com/v1/models \  -H "Authorization: Bearer $QIRNAS_API_KEY" \  -H "x-request-id: checkout-7f3a" | grep -i x-request-id# x-request-id: checkout-7f3a