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

# البدء السريع

> بدء سريع لواجهة Venice API — أنشئ مفتاح API، وأرسل أول طلب إكمال محادثة، واستكشف نقاط نهاية الصور والفيديو والصوت في دقائق.

ابدأ باستخدام Venice API في دقائق. أنشئ مفتاح API، وأرسل أول طلب، وابدأ في البناء.

## البدء السريع

<Steps>
  <Step title="احصل على مفتاح API الخاص بك">
    توجّه إلى [إعدادات Venice API](https://venice.ai/settings/api) الخاصة بك وأنشئ مفتاح API جديدًا.

    للاطلاع على شرح تفصيلي، راجع [دليل مفتاح API](/guides/getting-started/generating-api-key).
  </Step>

  <Step title="إعداد مفتاح API الخاص بك">
    أضف مفتاح API إلى بيئتك. يمكنك تصديره في الصدفة (shell):

    ```bash theme={"system"}
    export VENICE_API_KEY='your-api-key-here'
    ```

    أو أضفه إلى ملف `.env` في مشروعك:

    ```bash theme={"system"}
    VENICE_API_KEY=your-api-key-here
    ```
  </Step>

  <Step title="تثبيت SDK">
    Venice متوافق مع OpenAI، لذا يمكنك استخدام OpenAI SDK. إذا كنت تفضّل استخدام cURL أو طلبات HTTP الخام، يمكنك تخطي هذه الخطوة.

    <CodeGroup>
      ```bash Python theme={"system"}
      pip install openai
      ```

      ```bash Node.js theme={"system"}
      npm install openai
      ```
    </CodeGroup>
  </Step>

  <Step title="أرسل طلبك الأول">
    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.getenv("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "system", "content": "You are a helpful AI assistant"},
              {"role": "user", "content": "Why is privacy important?"}
          ]
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'system', content: 'You are a helpful AI assistant' },
              { role: 'user', content: 'Why is privacy important?' }
          ]
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "system", "content": "You are a helpful AI assistant"},
            {"role": "user", "content": "Why is privacy important?"}
          ]
        }'
      ```
    </CodeGroup>

    **أدوار الرسائل:**

    * `system` - تعليمات حول كيفية تصرّف النموذج
    * `user` - مطالباتك أو أسئلتك
    * `assistant` - استجابات النموذج السابقة (للمحادثات متعددة الأدوار)
    * `tool` - نتائج استدعاء الدوال (عند استخدام الأدوات)
  </Step>

  <Step title="بدّل النماذج عن طريق تغيير معرّف النموذج">
    كل طلب يتضمّن معرّف `model`. لاستخدام نموذج مختلف، غيّر قيمة `model` في طلبك. الخيارات الشائعة:

    * `zai-org-glm-5` - النموذج الافتراضي لمعظم حالات الاستخدام
    * `kimi-k2-6` - استدلال قوي للمهام الأكثر تعقيدًا
    * `claude-opus-4-8` - نموذج عالي الذكاء للمهام المعقدة
    * `venice-uncensored-1-2` - نموذج Venice غير الخاضع للرقابة

    <Card title="عرض جميع النماذج" icon="database" href="/overview/models">
      تصفّح القائمة الكاملة للنماذج مع الأسعار والقدرات وحدود السياق
    </Card>
  </Step>

  <Step title="استخدام معاملات Venice">
    يمكنك تفعيل ميزات خاصة بـ Venice مثل البحث على الويب باستخدام `venice_parameters`:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "user", "content": "What are the latest developments in AI?"}
          ],
          extra_body={
              "venice_parameters": {
                  "enable_web_search": "auto",
                  "include_venice_system_prompt": True
              }
          }
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'user', content: 'What are the latest developments in AI?' }
          ],
          venice_parameters: {
              enable_web_search: 'auto',
              include_venice_system_prompt: true
          }
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "user", "content": "What are the latest developments in AI?"}
          ],
          "venice_parameters": {
            "enable_web_search": "auto",
            "include_venice_system_prompt": true
          }
        }'
      ```
    </CodeGroup>

    اطّلع على جميع [المعاملات المتاحة](https://docs.venice.ai/api-reference/api-spec#venice-parameters).
  </Step>

  <Step title="تفعيل البث المباشر (اختياري)">
    قم ببث الاستجابات في الوقت الحقيقي باستخدام `stream=True`:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      stream = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[{"role": "user", "content": "Write a short story about AI"}],
          stream=True
      )

      for chunk in stream:
          if chunk.choices and chunk.choices[0].delta.content is not None:
              print(chunk.choices[0].delta.content, end="")
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const stream = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [{ role: 'user', content: 'Write a short story about AI' }],
          stream: true
      });

      for await (const chunk of stream) {
          if (chunk.choices && chunk.choices[0]?.delta?.content) {
              process.stdout.write(chunk.choices[0].delta.content);
          }
      }
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "user", "content": "Write a short story about AI"}
          ],
          "stream": true
        }'
      ```
    </CodeGroup>
  </Step>

  <Step title="تخصيص سلوك الاستجابة (اختياري)">
    تحكّم في كيفية استجابة النموذج باستخدام معاملات مثل temperature و max tokens والمزيد:

    <CodeGroup>
      ```python Python theme={"system"}
      import os
      from openai import OpenAI

      client = OpenAI(
          api_key=os.environ.get("VENICE_API_KEY"),
          base_url="https://api.venice.ai/api/v1"
      )

      completion = client.chat.completions.create(
          model="zai-org-glm-5",
          messages=[
              {"role": "system", "content": "You are a creative storyteller"},
              {"role": "user", "content": "Tell me a creative story"}
          ],
          temperature=0.8,
          max_tokens=500,
          top_p=0.9,
          frequency_penalty=0.5,
          presence_penalty=0.5,
          extra_body={
              "venice_parameters": {
                  "include_venice_system_prompt": False
              }
          }
      )

      print(completion.choices[0].message.content)
      ```

      ```javascript Node.js theme={"system"}
      import OpenAI from 'openai';

      const client = new OpenAI({
          apiKey: process.env.VENICE_API_KEY,
          baseURL: 'https://api.venice.ai/api/v1'
      });

      const completion = await client.chat.completions.create({
          model: 'zai-org-glm-5',
          messages: [
              { role: 'system', content: 'You are a creative storyteller' },
              { role: 'user', content: 'Tell me a creative story' }
          ],
          temperature: 0.8,
          max_tokens: 500,
          top_p: 0.9,
          frequency_penalty: 0.5,
          presence_penalty: 0.5,
          venice_parameters: {
              include_venice_system_prompt: false
          }
      });

      console.log(completion.choices[0].message.content);
      ```

      ```bash cURL theme={"system"}
      curl https://api.venice.ai/api/v1/chat/completions \
        -H "Authorization: Bearer $VENICE_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{
          "model": "zai-org-glm-5",
          "messages": [
            {"role": "system", "content": "You are a creative storyteller"},
            {"role": "user", "content": "Tell me a creative story"}
          ],
          "temperature": 0.8,
          "max_tokens": 500,
          "top_p": 0.9,
          "frequency_penalty": 0.5,
          "presence_penalty": 0.5,
          "stream": false,
          "venice_parameters": {
            "include_venice_system_prompt": false
          }
        }'
      ```
    </CodeGroup>

    اطّلع على [وثائق Chat Completions](/api-reference/endpoint/chat/completions) لمزيد من المعلومات حول جميع المعاملات المدعومة.
  </Step>
</Steps>

***

## الخطوات التالية

الآن بعد أن أرسلت طلباتك الأولى، استكشف المزيد مما يقدّمه Venice API:

<CardGroup cols={2}>
  <Card title="تصفّح النماذج" icon="database" href="/overview/models">
    قارن جميع النماذج المتاحة مع قدراتها وأسعارها وحدود السياق
  </Card>

  <Card title="مرجع API" icon="code" href="/api-reference/api-spec">
    استكشف وثائق API التفصيلية مع جميع نقاط النهاية والمعاملات
  </Card>

  <Card title="الاستجابات المنظّمة" icon="brackets-curly" href="/guides/features/structured-responses">
    تعرّف على كيفية الحصول على استجابات JSON بمخطّطات مضمونة
  </Card>

  <Card title="دليل وكلاء الذكاء الاصطناعي" icon="robot" href="/guides/integrations/ai-agents">
    ابنِ باستخدام تطبيقات الوكلاء ووكلاء البرمجة وأدوات MCP والمهارات وسير عمل العملات المشفّرة
  </Card>
</CardGroup>

### موارد إضافية

<CardGroup cols={2}>
  <Card title="تحديد المعدّل" icon="gauge" href="/api-reference/rate-limiting">
    افهم حدود المعدّل وأفضل الممارسات للاستخدام في الإنتاج
  </Card>

  <Card title="رموز الأخطاء" icon="triangle-exclamation" href="/api-reference/error-codes">
    مرجع للتعامل مع أخطاء API واستكشاف المشكلات وإصلاحها
  </Card>

  <Card title="مجموعة Postman" icon="bolt" href="/guides/getting-started/postman">
    استورد مجموعة Postman الكاملة الخاصة بنا لسهولة الاختبار
  </Card>

  <Card title="الخصوصية والأمان" icon="shield" href="/overview/privacy">
    تعرّف على بنية Venice التي تعطي الأولوية للخصوصية وطريقة التعامل مع البيانات
  </Card>
</CardGroup>

***

## تحتاج إلى مساعدة؟

* **مجتمع Discord**: انضم إلى [خادم Discord](https://discord.gg/askvenice) الخاص بنا للحصول على الدعم والمناقشات
* **الوثائق**: تصفّح [مرجع API الكامل](/api-reference/api-spec) الخاص بنا
* **صفحة الحالة**: تحقّق من حالة الخدمة على [veniceai-status.com](https://veniceai-status.com)
* **Twitter**: تابع [@AskVenice](https://x.com/AskVenice) لمعرفة التحديثات

<Resources />