Quick Start
Get started with Lingyi in under 2 minutes:
from portkey_ai import Portkey
# 1. Install: pip install portkey-ai
# 2. Add @lingyi provider in model catalog
# 3. Use it:
portkey = Portkey(api_key="PORTKEY_API_KEY")
response = portkey.chat.completions.create(
model="@lingyi/Yi-Large-Preview",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
import Portkey from 'portkey-ai'
// 1. Install: npm install portkey-ai
// 2. Add @lingyi provider in model catalog
// 3. Use it:
const portkey = new Portkey({
apiKey: "PORTKEY_API_KEY"
})
const response = await portkey.chat.completions.create({
model: "@lingyi/Yi-Large-Preview",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL
# 1. Install: pip install openai portkey-ai
# 2. Add @lingyi provider in model catalog
# 3. Use it:
client = OpenAI(
api_key="PORTKEY_API_KEY", # Portkey API key
base_url=PORTKEY_GATEWAY_URL
)
response = client.chat.completions.create(
model="@lingyi/Yi-Large-Preview",
messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)
import OpenAI from "openai"
import { PORTKEY_GATEWAY_URL } from "portkey-ai"
// 1. Install: npm install openai portkey-ai
// 2. Add @lingyi provider in model catalog
// 3. Use it:
const client = new OpenAI({
apiKey: "PORTKEY_API_KEY", // Portkey API key
baseURL: PORTKEY_GATEWAY_URL
})
const response = await client.chat.completions.create({
model: "@lingyi/Yi-Large-Preview",
messages: [{ role: "user", content: "Hello!" }]
})
console.log(response.choices[0].message.content)
# 1. Add @lingyi provider in model catalog
# 2. Use it:
curl https://api.portkey.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-d '{
"model": "@lingyi/Yi-Large-Preview",
"messages": [{"role": "user", "content": "Hello!"}]
}'
Tip: You can also set provider="@lingyi" in Portkey() and use just model="Yi-Large-Preview" in the request.
Add Provider in Model Catalog
Before making requests, add Lingyi to your Model Catalog:
- Go to Model Catalog → Add Provider
- Select Lingyi (01.ai)
- Enter your Lingyi API key
- Name your provider (e.g.,
lingyi)
Complete Setup Guide
See all setup options and detailed configuration instructions
Supported Models
Lingyi (01.ai) provides the Yi model family:
| Model | Description |
|---|
| Yi-Large-Preview | Latest Yi large model preview |
| Yi-Medium | Medium-sized Yi model |
| Yi-Vision | Multimodal Yi model with vision |
Check Lingyi’s documentation for the complete model list.
Next Steps
Gateway Configs
Add fallbacks, load balancing, and more
Observability
Monitor and trace your Lingyi requests
Prompt Library
Manage and version your prompts
Metadata
Add custom metadata to requests
For complete SDK documentation:
SDK Reference
Complete Portkey SDK documentation