> ## 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.

# Modal Labs

> Integrate Modal with Prisma AIRS AI Gateway for seamless completions and streaming.

## Quick Start

Get started with Modal in under 2 minutes:

```sh cURL icon="square-terminal" theme={"system"}
# 1. Add @modal 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": "@modal/your-model-name",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'
```

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

# 1. Install: pip install openai
# 2. Add @modal 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="@modal/your-model-name",
    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 @modal 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: "@modal/your-model-name",
    messages: [{ role: "user", content: "Hello!" }]
})

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

> [!NOTE]
>
> **Tip:** You can also send `x-portkey-provider: @modal` as a header and use just `model="your-model-name"` in the request.

## Add Provider in Model Catalog

Before making requests, add Modal to your Model Catalog:

1. Go to [**Model Catalog → Add Provider**](https://stratacloudmanager.paloaltonetworks.com/)
2. Select **Modal**
3. Enter your [Modal API credentials](https://modal.com/)
   * Modal supports **API Key** (Bearer token) or **Custom Headers** (`modal-key` and `modal-secret`)
4. **Custom Host:** Enter your Modal deployment endpoint (e.g., `https://your-modal-deployment.modal.run`)
5. Name your provider (e.g., `modal`)

> [!NOTE]
>
> **Note:** Custom host configuration is set once in Model Catalog and applies to all requests using this provider.

> **[Complete Setup Guide](https://docs.portkey.ai/docs/aigw/product/model-catalog.md)**
>
> See all setup options and detailed configuration instructions

> **[Modal Documentation](https://modal.com/docs)**
>
> Explore the official Modal documentation

***

## Modal Capabilities

### Streaming

Stream responses for real-time output:

***

## Supported Endpoints and Parameters

| Endpoint | Supported Parameters |
| - | - |
| `/chat/completions` | messages, max\_tokens, temperature, top\_p, stream, presence\_penalty, frequency\_penalty |

***

## Next Steps

> **[Gateway Configs](https://docs.portkey.ai/docs/aigw/product/ai-gateway.md)**
>
> Add fallbacks, load balancing, and more

> **[Observability](https://docs.portkey.ai/docs/aigw/product/observability.md)**
>
> Monitor and trace your Modal requests

> **[Metadata](https://docs.portkey.ai/docs/aigw/product/observability/metadata.md)**
>
> Add custom metadata to requests


## Related topics

- [Enterprise Gateway](https://docs.portkey.ai/docs/changelog/enterprise.md)
- [Lambda Labs](https://docs.portkey.ai/docs/aigw/integrations/llms/lambda.md)
- [ElevenLabs](https://docs.portkey.ai/docs/aigw/integrations/llms/elevenlabs.md)
- [Connect Bedrock with Amazon Assumed Role](https://docs.portkey.ai/docs/aigw/product/model-catalog/connect-bedrock-with-amazon-assumed-role.md)


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