身份验证

为了确保安全访问 Portkey 的 API，所有请求都需要进行认证。本指南提供了使用 Portkey API 密钥对请求进行认证的必要步骤，无论您是使用 Python 和 JavaScript 的 SDK，OpenAI SDK，还是直接进行 REST API 调用。

获取您的 API 密钥

创建或登录您的 Portkey 账户。从“设置”页面 -> “API 密钥”选项卡获取您账户的 API 密钥。

使用SDK进行身份验证

Portkey SDKs

NodeJS SDK

import Portkey from 'portkey-ai'

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY", // 替换为您的实际 API 密钥
    virtualKey: "VIRTUAL_KEY"  // 可选：用于虚拟密钥管理
})

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

REST API

OpenAI SDK

在通过 OpenAI SDK 集成 Portkey 时，修改基础 URL 并添加 x-portkey-api-key 头以进行身份验证。以下是如何操作的示例：

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" // 替换为您的实际 Portkey API 密钥
});

// 继续使用您的 OpenAI SDK，利用头进行身份验证

Python

阅读更多信息 这里。