Skip to main content

Quick Start

Get started with Voyage AI in under 2 minutes:
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)
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
  2. Select Voyage AI
  3. Enter your Voyage API key
  4. Name your provider (e.g., voyage)

Complete Setup Guide

See all setup options and detailed configuration instructions

Voyage AI Capabilities

Embeddings

Generate high-quality embeddings:
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)

Rerank

Portkey supports Voyage AI’s reranking models through a unified /v1/rerank endpoint.
curl https://api.portkey.ai/v1/rerank \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "model": "@voyage-ai-prod/rerank-2",
    "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. Its capital is Saipan.",
      "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
      "Capital punishment (the death penalty) has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states."
    ],
    "top_n": 3
  }'

Voyage-Specific Parameters

ParameterTypeDescription
truncationbooleanWhether to truncate documents that exceed the model’s context length
=======

Reranking

Rerank documents for better search results:
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)

Supported Models

Voyage AI offers specialized embedding and reranking models:
ModelTypeDescription
voyage-3EmbeddingLatest general-purpose embedding model
voyage-3-liteEmbeddingFaster, lighter version
voyage-code-3EmbeddingOptimized for code
rerank-2RerankingHigh-quality reranking
rerank-2-liteRerankingFaster reranking
Check Voyage AI’s documentation for the complete model list.

Next Steps

Gateway Configs

Add fallbacks, load balancing, and more

Observability

Monitor and trace your Voyage requests

Caching

Cache embeddings for faster responses

Metadata

Add custom metadata to requests
For complete SDK documentation:

SDK Reference

Complete Portkey SDK documentation
Last modified on March 6, 2026