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

# Dashscope

> Integrate Dashscope with Prisma AIRS AI Gateway for seamless completions, embeddings, and advanced features.

## Quick Start

Get started with Dashscope in under 2 minutes:

<CodeGroup>
  ```sh cURL icon="square-terminal" theme={"system"}
  # 1. Add @dashscope provider in model catalog
  # 2. Use it:

  curl https://aigw.portkey.ai/v1/chat/completions \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $PORTKEY_API_KEY" \
    -d '{
      "model": "@dashscope/qwen-turbo",
      "messages": [{"role": "user", "content": "Hello!"}]
    }'
  ```

  ```python OpenAI Py icon="python" theme={"system"}
  from openai import OpenAI

  # 1. Install: pip install openai
  # 2. Add @dashscope provider in model catalog
  # 3. Use it:

  client = OpenAI(
      api_key="PORTKEY_API_KEY",  # AI Gateway API key
      base_url="https://aigw.portkey.ai/v1"
  )

  response = client.chat.completions.create(
      model="@dashscope/qwen-turbo",
      messages=[{"role": "user", "content": "Hello!"}]
  )

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

  ```js OpenAI JS icon="square-js" theme={"system"}
  import OpenAI from "openai"

  // 1. Install: npm install openai
  // 2. Add @dashscope provider in model catalog
  // 3. Use it:

  const client = new OpenAI({
      apiKey: "PORTKEY_API_KEY",  // AI Gateway API key
      baseURL: "https://aigw.portkey.ai/v1"
  })

  const response = await client.chat.completions.create({
      model: "@dashscope/qwen-turbo",
      messages: [{ role: "user", content: "Hello!" }]
  })

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

## Add Provider in Model Catalog

Before making requests, add Dashscope to your Model Catalog:

1. Go to [**Model Catalog → Add Provider**](https://stratacloudmanager.paloaltonetworks.com/)
2. Select **Dashscope**
3. Enter your [Dashscope API key](https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key)
4. Name your provider (e.g., `dashscope`)

<Card title="Complete Setup Guide" icon="book" href="/docs/aigw/product/model-catalog">
  See all setup options and detailed configuration instructions
</Card>

<Card title="Dashscope Documentation" icon="book" href="https://help.aliyun.com/zh/model-studio/developer-reference/compatibility-of-openai-with-dashscope">
  Explore the official Dashscope documentation
</Card>

***

## Dashscope Capabilities

### Embeddings

Generate embeddings for text using Dashscope embedding models:

***

## Advanced Features

### Track End-User IDs

Monitor user-level costs and requests by passing user IDs:

<Card title="Learn More About Metadata" icon="tags" href="/docs/aigw/product/observability/metadata">
  Explore how to use custom metadata to enhance your request tracking and analysis
</Card>

### Gateway Configurations

Use the AI Gateway features for advanced routing and reliability:

**Example: Conditional Routing**

```json theme={"system"}
{
  "strategy": {
    "mode": "conditional",
    "conditions": [
      {
        "query": { "metadata.user_plan": { "$eq": "paid" } },
        "then": "qwen-turbo"
      },
      {
        "query": { "metadata.user_plan": { "$eq": "free" } },
        "then": "gpt-3.5"
      }
    ],
    "default": "gpt-3.5"
  },
  "targets": [
    {
      "name": "qwen-turbo",
      "provider": "@dashscope"
    },
    {
      "name": "gpt-3.5",
      "provider": "@openai"
    }
  ]
}
```

<CardGroup cols={2}>
  <Card title="Load Balancing" icon="link" href="/docs/aigw/product/ai-gateway/load-balancing">
    Distribute requests across multiple targets
  </Card>

  <Card title="Fallbacks" icon="life-ring" href="/docs/aigw/product/ai-gateway/fallbacks">
    Automatically switch to backup targets
  </Card>

  <Card title="Conditional Routing" icon="route" href="/docs/aigw/product/ai-gateway/conditional-routing">
    Route requests based on conditions
  </Card>

  <Card title="Caching" icon="database" href="/docs/aigw/product/ai-gateway/cache-simple-and-semantic">
    Cache responses to reduce costs
  </Card>
</CardGroup>

### Guardrails

Enforce input/output checks with custom hooks:

```json theme={"system"}
{
  "provider": "@dashscope",
  "before_request_hooks": [{
    "id": "input-guardrail-id-xx"
  }],
  "after_request_hooks": [{
    "id": "output-guardrail-id-xx"
  }]
}
```

<Card title="Learn More About Guardrails" icon="shield-check" href="/docs/aigw/product/guardrails">
  Enhance security and reliability with AI Gateway Guardrails
</Card>

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Gateway Configs" icon="sliders" href="/docs/aigw/product/ai-gateway">
    Add fallbacks, load balancing, and more
  </Card>

  <Card title="Observability" icon="chart-line" href="/docs/aigw/product/observability">
    Monitor and trace your Dashscope requests
  </Card>

  <Card title="Metadata" icon="tag" href="/docs/aigw/product/observability/metadata">
    Add custom metadata to requests
  </Card>
</CardGroup>

***

For the most up-to-date information on supported features and endpoints, please refer to our [API Reference](/docs/aigw/api-reference/inference-api/introduction).


## Related topics

- [Prisma AIRS AI Gateway Models](/docs/aigw/product/model-catalog/gateway-models.md)
- [Overview](/docs/aigw/integrations/llms.md)
- [Enterprise Gateway](/docs/aigw/changelog/enterprise.md)
- [Supported Providers](/docs/aigw/api-reference/inference-api/supported-providers.md)