BYOKSBYOKS Docs

API

API 概览

BYOKS 完全兼容 OpenAI API,你可以使用任何 OpenAI SDK 或 HTTP 客户端。

Base URL

https://api.byoks.com/v1

认证

使用 Bearer Token 认证:

Authorization: Bearer your-byoks-key

示例

curl https://api.byoks.com/v1/chat/completions \
  -H "Authorization: Bearer your-byoks-key" \
  -H "Content-Type: application/json" \
  -d '{"model": "gpt-4o", "messages": [{"role": "user", "content": "你好"}]}'

端点列表

端点方法说明
/v1/chat/completionsPOST创建聊天补全
/v1/modelsGET列出可用模型
/v1/embeddingsPOST创建嵌入向量

请求头

必填说明
AuthorizationBearer Token 认证
Content-Typeapplication/json
x-byoks-cache缓存控制:skip 跳过缓存
x-byoks-provider指定 Provider

响应头

说明
x-byoks-provider实际使用的 Provider ID
x-byoks-latency请求延迟(毫秒)
x-byoks-cached是否命中缓存

SDK 使用

TypeScript / JavaScript

import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.byoks.com/v1',
  apiKey: 'your-byoks-key',
});

Python

from openai import OpenAI

client = OpenAI(
    base_url="https://api.byoks.com/v1",
    api_key="your-byoks-key",
)

环境变量

你也可以通过环境变量配置:

export OPENAI_BASE_URL=https://api.byoks.com/v1
export OPENAI_API_KEY=your-byoks-key

然后直接使用 SDK:

import OpenAI from 'openai';

const client = new OpenAI();  // 自动读取环境变量

速率限制

限制
每分钟请求数取决于你的套餐
并发连接数100
单次请求超时10 分钟

超过限制时返回 429 Too Many Requests

下一步