> ## Documentation Index
> Fetch the complete documentation index at: https://portkey-docs-feature-comparison-update.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Voyage AI
> Use Voyage AI's embeddings and reranking models through Portkey.
## Quick Start
Get started with Voyage AI in under 2 minutes:
```python Python icon="python" theme={null}
from portkey_ai import Portkey
# 1. Install: pip install portkey-ai
# 2. Add @voyage provider in model catalog
# 3. Use it:
portkey = Portkey(api_key="PORTKEY_API_KEY")
embedding = portkey.embeddings.create(
model="@voyage/voyage-3",
input="Name the tallest buildings in Hawaii"
)
print(embedding.data[0].embedding)
```
```js Javascript icon="square-js" theme={null}
import Portkey from 'portkey-ai'
// 1. Install: npm install portkey-ai
// 2. Add @voyage provider in model catalog
// 3. Use it:
const portkey = new Portkey({
apiKey: "PORTKEY_API_KEY"
})
const embedding = await portkey.embeddings.create({
model: "@voyage/voyage-3",
input: "Name the tallest buildings in Hawaii"
})
console.log(embedding.data[0].embedding)
```
```python OpenAI Py icon="python" theme={null}
from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL
# 1. Install: pip install openai portkey-ai
# 2. Add @voyage provider in model catalog
# 3. Use it:
client = OpenAI(
api_key="PORTKEY_API_KEY", # Portkey API key
base_url=PORTKEY_GATEWAY_URL
)
embedding = client.embeddings.create(
model="@voyage/voyage-3",
input="Name the tallest buildings in Hawaii"
)
print(embedding.data[0].embedding)
```
```js OpenAI JS icon="square-js" theme={null}
import OpenAI from "openai"
import { PORTKEY_GATEWAY_URL } from "portkey-ai"
// 1. Install: npm install openai portkey-ai
// 2. Add @voyage provider in model catalog
// 3. Use it:
const client = new OpenAI({
apiKey: "PORTKEY_API_KEY", // Portkey API key
baseURL: PORTKEY_GATEWAY_URL
})
const embedding = await client.embeddings.create({
model: "@voyage/voyage-3",
input: "Name the tallest buildings in Hawaii"
})
console.log(embedding.data[0].embedding)
```
```bash cURL icon="square-terminal" theme={null}
# 1. Add @voyage provider in model catalog
# 2. Use it:
curl https://api.portkey.ai/v1/embeddings \
-H "Content-Type: application/json" \
-H "x-portkey-api-key: $PORTKEY_API_KEY" \
-d '{
"model": "@voyage/voyage-3",
"input": "Name the tallest buildings in Hawaii"
}'
```
**Tip:** You can also set `provider="@voyage"` in `Portkey()` and use just `model="voyage-3"` in the request.
## Add Provider in Model Catalog
Before making requests, add Voyage AI to your Model Catalog:
1. Go to [**Model Catalog → Add Provider**](https://app.portkey.ai/model-catalog/providers)
2. Select **Voyage AI**
3. Enter your [Voyage API key](https://dash.voyageai.com/)
4. Name your provider (e.g., `voyage`)
See all setup options and detailed configuration instructions
***
## Voyage AI Capabilities
### Embeddings
Generate high-quality embeddings:
```python Python theme={null}
from portkey_ai import Portkey
portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@voyage")
embedding = portkey.embeddings.create(
model="voyage-3",
input="Name the tallest buildings in Hawaii"
)
print(embedding.data[0].embedding)
```
```javascript Node.js theme={null}
import Portkey from 'portkey-ai';
const portkey = new Portkey({
apiKey: 'PORTKEY_API_KEY',
provider: '@voyage'
});
const embedding = await portkey.embeddings.create({
model: "voyage-3",
input: "Name the tallest buildings in Hawaii"
});
console.log(embedding.data[0].embedding);
```
### Reranking
Rerank documents for better search results:
```python Python theme={null}
from portkey_ai import Portkey
portkey = Portkey(api_key="PORTKEY_API_KEY", provider="@voyage")
response = portkey.post(
"/rerank",
model="rerank-2-lite",
query="What is the capital of the United States?",
documents=[
"Carson City is the capital city of the American state of Nevada.",
"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean.",
"Washington, D.C. is the capital of the United States.",
"Capital punishment has existed in the United States since before it was a country."
]
)
print(response)
```
```javascript Node.js theme={null}
import Portkey from 'portkey-ai';
const portkey = new Portkey({
apiKey: 'PORTKEY_API_KEY',
provider: '@voyage'
});
const response = await portkey.post(
"/rerank",
{
model: "rerank-2-lite",
query: "What is the capital of the United States?",
documents: [
"Carson City is the capital city of the American state of Nevada.",
"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean.",
"Washington, D.C. is the capital of the United States.",
"Capital punishment has existed in the United States since before it was a country."
]
}
);
console.log(response);
```
***
## Supported Models
Voyage AI offers specialized embedding and reranking models:
| Model | Type | Description |
| ------------- | --------- | -------------------------------------- |
| voyage-3 | Embedding | Latest general-purpose embedding model |
| voyage-3-lite | Embedding | Faster, lighter version |
| voyage-code-3 | Embedding | Optimized for code |
| rerank-2 | Reranking | High-quality reranking |
| rerank-2-lite | Reranking | Faster reranking |
Check [Voyage AI's documentation](https://docs.voyageai.com/) for the complete model list.
***
## Next Steps
Add fallbacks, load balancing, and more
Monitor and trace your Voyage requests
Cache embeddings for faster responses
Add custom metadata to requests
For complete SDK documentation:
Complete Portkey SDK documentation