Skip to content
获取 API Key
集成指南

SDK 与客户端 ​

修改服务地址和密钥,将熟悉的客户端接入 OceanWay。

Python · OpenAI SDK ​

bash
python -m pip install openai
python
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["OCEANWAY_API_KEY"],
    base_url="https://console.oceanway.tech/v1",
    max_retries=0,
)
print(client.models.list())

此示例只读取目录,不创建生成请求。实际调用见 快速开始。

TypeScript · OpenAI SDK ​

bash
npm install openai
typescript
import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env.OCEANWAY_API_KEY,
  baseURL: 'https://console.oceanway.tech/v1',
  maxRetries: 0,
});
const models = await client.models.list();
console.log(models.data);

在服务端运行,不要在浏览器中开启直接使用 Key 的模式。

Anthropic SDK ​

bash
python -m pip install anthropic
python
import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ["OCEANWAY_API_KEY"],
    base_url="https://console.oceanway.tech",
    max_retries=0,
)
message = client.messages.create(
    model=os.environ["OCEANWAY_MESSAGES_MODEL"],
    max_tokens=128,
    messages=[{"role": "user", "content": "你好"}],
)
print(message.content)

Anthropic SDK 自动拼接 /v1/messages,因此 base_url 使用不带 /v1 的 API Root。模型必须支持 Messages 协议。该示例会产生实际模型用量。

其他兼容客户端 ​

选择支持自定义服务地址的客户端,并核对它使用的协议:

配置项填写内容
API Key在 OceanWay 控制台创建的密钥
OpenAI Base URLhttps://console.oceanway.tech/v1
模型目录中支持该协议的准确模型 ID
自动重试先关闭生成请求的自动重试,再按接口语义设计恢复

部分客户端会自动添加 /v1,另一些要求你填写完整前缀。出现 404 时先检查最终请求 URL 是否重复包含 /v1。

兼容范围 ​

协议兼容不表示某个客户端的全部功能都可用。工具、图片输入、托管工具、远程历史等扩展能力,需要模型和平台同时支持。优先使用模型详情提供的接入示例验证最小调用。

客户端报错或网络超时后,先查看原请求与记录。示例关闭 SDK 自动重试,以免在结果未明时重复发起收费请求。