快速开始

从创建密钥到发起请求，只需完成下面三步。

1. 创建 API Key

登录 OceanWay 控制台，进入 API Key 页面创建密钥。将密钥保存在服务端环境变量中。

export OCEANWAY_BASE_URL="https://console.oceanway.tech"
# OCEANWAY_API_KEY 从你的服务端密钥管理器注入。

账户余额与 Key 的额度分别生效。开始调用前，在 充值与订阅 中检查账户可用资源，并确认 Key 已启用。

2. 选择一个模型

打开 模型目录，选择支持 OpenAI Chat 协议的文本模型，复制准确的模型 ID。

也可以通过 API 读取当前 Key 可访问的目录：

curl --fail-with-body "$OCEANWAY_BASE_URL/v1/models" \
  -H "Authorization: Bearer $OCEANWAY_API_KEY"

将选定模型保存到环境变量，替换下面的占位值：

export OCEANWAY_TEXT_MODEL="YOUR_MODEL_ID"

3. 发起文本请求

以下请求会产生实际模型用量，按模型当前价格计费。HTTP 示例使用原生 Chat Completions 格式。

cURL

curl --fail-with-body "$OCEANWAY_BASE_URL/v1/chat/completions" \
  -H "Authorization: Bearer $OCEANWAY_API_KEY" \
  -H "Content-Type: application/json" \
  --data "{\"model\":\"$OCEANWAY_TEXT_MODEL\",\"messages\":[{\"role\":\"user\",\"content\":\"用一句话介绍 OceanWay。\"}],\"max_tokens\":128}"

Python

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["OCEANWAY_API_KEY"],
    base_url=os.environ["OCEANWAY_BASE_URL"].rstrip("/") + "/v1",
    max_retries=0,
)
result = client.chat.completions.create(
    model=os.environ["OCEANWAY_TEXT_MODEL"],
    messages=[{"role": "user", "content": "用一句话介绍 OceanWay。"}],
    max_tokens=128,
)
print(result.choices[0].message.content)

TypeScript

import OpenAI from 'openai';

const model = process.env.OCEANWAY_TEXT_MODEL;
if (!model) throw new Error('Set OCEANWAY_TEXT_MODEL');

const client = new OpenAI({
  apiKey: process.env.OCEANWAY_API_KEY,
  baseURL: (process.env.OCEANWAY_BASE_URL || 'https://console.oceanway.tech').replace(/\/$/, '') + '/v1',
  maxRetries: 0,
});
const result = await client.chat.completions.create({
  model,
  messages: [{ role: 'user', content: '用一句话介绍 OceanWay。' }],
  max_tokens: 128,
});
console.log(result.choices[0].message.content);

Python 先安装 openai，Node.js 先安装 openai 并使用支持环境变量的服务端运行环境。完整配置见 SDK 与客户端。

查看结果和用量

非流式文本请求返回原协议的 JSON。Chat Completions 的文本通常位于 choices[0].message.content，用量位于 usage；具体字段以模型返回为准。

在控制台的 调用记录 查看本次用量与费用。图片、视频使用各自的生成和任务查询流程。

请求等待中

已开始的非流式请求会继续处理，关闭页面或客户端不会取消它。网络中断后，先检查原请求与调用记录，再决定下一步。详见 错误与重试。

下一步

了解文本 API选择适合模型的协议，处理普通响应和流式响应。

开始图像生成了解图像参数、同步结果与异步任务。