> ## Documentation Index
> Fetch the complete documentation index at: https://docs.teamsoclo.site/llms.txt
> Use this file to discover all available pages before exploring further.

# cURL / Python / Node.js

> استدعاء الواجهة البرمجية مباشرة بمكتبات OpenAI الرسمية

كل مكتبة OpenAI رسمية تعمل؛ فقط `base_url` يتغير. الأمثلة تستخدم `gpt-5.6-sol`؛ لباقة Astra استخدم `gpt-astra`.

## Chat Completions

<CodeGroup>
  ```bash cURL theme={null}
  curl https://gpt.teamsoclo.site/v1/chat/completions \
    -H "Authorization: Bearer sk-xxx" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "gpt-5.6-sol",
      "messages": [
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Explain closures in JavaScript"}
      ]
    }'
  ```

  ```python Python theme={null}
  from openai import OpenAI

  client = OpenAI(
      api_key="sk-xxx",
      base_url="https://gpt.teamsoclo.site/v1",
  )

  resp = client.chat.completions.create(
      model="gpt-5.6-sol",
      messages=[
          {"role": "system", "content": "You are a helpful assistant."},
          {"role": "user", "content": "Explain closures in JavaScript"},
      ],
  )

  print(resp.choices[0].message.content)
  print(resp.usage)
  ```

  ```javascript Node.js theme={null}
  import OpenAI from "openai"

  const client = new OpenAI({
    apiKey: "sk-xxx",
    baseURL: "https://gpt.teamsoclo.site/v1",
  })

  const resp = await client.chat.completions.create({
    model: "gpt-5.6-sol",
    messages: [
      { role: "system", content: "You are a helpful assistant." },
      { role: "user", content: "Explain closures in JavaScript" },
    ],
  })

  console.log(resp.choices[0].message.content)
  console.log(resp.usage)
  ```
</CodeGroup>

<Warning>
  `base_url` يجب أن يتضمن `/v1` و**ألّا** ينتهي بـ `/`. المكتبة تضيف `/chat/completions` تلقائياً.
</Warning>

الاستجابات تتبع مخطط OpenAI تماماً: `id` هو `chatcmpl-...`، `usage` يحتوي `prompt_tokens` و`completion_tokens` و`completion_tokens_details.reasoning_tokens`. تُحسب الحصة بالضبط من `usage.total_tokens`.

## Responses API

Codex والـ SDKs الأحدث يستخدمان هذا البروتوكول. إعداد الاستدلال في `reasoning.effort`.

<CodeGroup>
  ```bash cURL theme={null}
  curl https://gpt.teamsoclo.site/v1/responses \
    -H "Authorization: Bearer sk-xxx" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "gpt-5.6-sol",
      "input": "Write a Python function that checks for primes",
      "reasoning": {"effort": "medium"}
    }'
  ```

  ```python Python theme={null}
  resp = client.responses.create(
      model="gpt-5.6-sol",
      input="Write a Python function that checks for primes",
      reasoning={"effort": "medium"},
  )
  print(resp.output_text)
  ```
</CodeGroup>

## جهد الاستدلال

مع Chat Completions استخدم `reasoning_effort` (`low`, `medium`, `high`). إن لم تضبطه، تستخدم البوابة `high`. للمهام البسيطة اضبط `low` لتوفير الرموز:

```python theme={null}
resp = client.chat.completions.create(
    model="gpt-5.6-sol",
    reasoning_effort="low",
    messages=[{"role": "user", "content": "Translate to French: good morning"}],
)
```

<Warning>
  `reasoning_effort` لـ Chat Completions فقط. مع Responses API استخدم `reasoning: {"effort": ...}`؛ إرسال `reasoning_effort` إلى `/v1/responses` يُرفض بـ "Unsupported parameter".
</Warning>

## البث

<CodeGroup>
  ```python Python theme={null}
  stream = client.chat.completions.create(
      model="gpt-5.6-sol",
      messages=[{"role": "user", "content": "Write a short paragraph about autumn"}],
      stream=True,
      stream_options={"include_usage": True},
  )

  for chunk in stream:
      if chunk.choices and chunk.choices[0].delta.content:
          print(chunk.choices[0].delta.content, end="", flush=True)
      if chunk.usage:
          print("\n", chunk.usage)
  ```

  ```bash cURL theme={null}
  curl https://gpt.teamsoclo.site/v1/chat/completions \
    -H "Authorization: Bearer sk-xxx" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "gpt-5.6-sol",
      "messages": [{"role": "user", "content": "Write a short paragraph about autumn"}],
      "stream": true,
      "stream_options": {"include_usage": true}
    }'
  ```
</CodeGroup>

<Tip>
  في الأسئلة الصعبة قد يفكر النموذج فترة قبل أول رمز. استخدم `stream: true` لعدم انقطاع الاتصال. `stream_options.include_usage` يجعل القطعة الأخيرة تحمل `usage` لتتمكن من تسوية الحصة بنفسك.
</Tip>

## إرسال الصور (vision)

الصور تذهب في مصفوفة `content`، كرابط عام أو base64 للملفات المحلية.

<CodeGroup>
  ```python Image URL theme={null}
  resp = client.chat.completions.create(
      model="gpt-5.6-sol",
      messages=[{
          "role": "user",
          "content": [
              {"type": "text", "text": "What error does this show?"},
              {"type": "image_url", "image_url": {"url": "https://example.com/screenshot.png"}},
          ],
      }],
  )
  print(resp.choices[0].message.content)
  ```

  ```python Local file (base64) theme={null}
  import base64

  with open("screenshot.png", "rb") as f:
      b64 = base64.b64encode(f.read()).decode()

  resp = client.chat.completions.create(
      model="gpt-5.6-sol",
      messages=[{
          "role": "user",
          "content": [
              {"type": "text", "text": "What error does this show?"},
              {"type": "image_url", "image_url": {"url": f"data:image/png;base64,{b64}"}},
          ],
      }],
  )
  print(resp.choices[0].message.content)
  ```
</CodeGroup>

<Warning>
  الصور تكلّف رموزاً حسب الحجم. اقتص القسم المعني بدلاً من إرسال لقطة شاشة 4K كاملة.
</Warning>

## النماذج والحصة عبر الواجهة البرمجية

```bash theme={null}
# النماذج التي يمكن لهذا المفتاح استدعاؤها
curl https://gpt.teamsoclo.site/v1/models -H "Authorization: Bearer sk-xxx"

# الحصة (نقاط نهاية OpenAI القديمة)
curl https://gpt.teamsoclo.site/v1/dashboard/billing/subscription -H "Authorization: Bearer sk-xxx"
curl https://gpt.teamsoclo.site/v1/dashboard/billing/usage -H "Authorization: Bearer sk-xxx"
```

`subscription` يُعيد الإجمالي في `hard_limit_usd`؛ `usage` يُعيد المستخدَم في `total_usage`، بـ **سنتات** (اقسم على 100 قبل المقارنة). [صفحة التحقق](https://gpt.teamsoclo.site/check) تفعل هذا تلقائياً.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.