Authentication

To ensure secure access to Portkey's APIs, authentication is required for all requests. This guide provides the necessary steps to authenticate your requests using the Portkey API key, regardless of whether you are using the SDKs for Python and JavaScript, the OpenAI SDK, or making REST API calls directly.

Obtaining Your API Key

Your Portkey API key is the primary credential for authentication. To find it:

1. Log in to your Portkey account.

2. Navigate to the dropdown menu in the profile section.

3. Locate and copy your API key.

Authentication with SDKs

Portkey SDKs

NodeJS SDK

import Portkey from 'portkey-ai'

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY", // Replace with your actual API key
    virtualKey: "VIRTUAL_KEY"  // Optional: Use for virtual key management
})

const chatCompletion = await portkey.chat.completions.create({
    messages: [{ role: 'user', content: 'Say this is a test' }],
    model: 'gpt-3.5-turbo',
});

console.log(chatCompletion.choices);

Python SDK

from portkey_ai import Portkey

client = Portkey(
    api_key="PORTKEY_API_KEY",  # Replace with your actual API key
    virtual_key="VIRTUAL_KEY"   # Optional: Use if virtual keys are set up
)

chat_completion = client.chat.completions.create(
    messages=[{"role": "user", "content": "Say this is a test"}],
    model='gpt-3.5-turbo'
)

print(chat_completion.choices[0].message["content"])

REST API

curl https://api.portkey.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $VIRTUAL_KEY" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [
      { "role": "system", "content": "You are a helpful assistant." },
      { "role": "user", "content": "Hello!" }
    ]
  }'

OpenAI SDK

When integrating Portkey through the OpenAI SDK, modify the base URL and add the x-portkey-api-key header for authentication. Here's an example of how to do it:

NodeJS

import openai from 'openai';
import { PORTKEY_GATEWAY_URL, createHeaders } from 'portkey-ai';

openai.api_base = PORTKEY_GATEWAY_URL;

const headers = createHeaders({
    provider: "openai",
    apiKey: "PORTKEY_API_KEY" // Replace with your actual Portkey API key
});

// Continue with your OpenAI SDK usage, utilizing the headers for authentication

Python

from openai import OpenAI
from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders

openai_client = OpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    default_headers=createHeaders(
        api_key="PORTKEY-API-KEY",
        provider="openai"
    )
)
response = openai_client.chat.completions.create(
        messages=[{'role': 'user', 'content': 'Say this is a test'}],
        model='gpt-3.5-turbo'
)

Read more here.