TypeScript API 参考

导入

1import { JoyTokenClient, JoyTokenAPIError } from "@joytoken/client-sdk-ts";

JoyTokenClient

1const joytoken = new JoyTokenClient({
2 apiKey: process.env.JOY_TOKEN_API_KEY,
3 apiBaseUrl: process.env.JOY_TOKEN_API_BASE_URL,
4 openAIBaseUrl: process.env.JOY_TOKEN_OPENAI_BASE_URL,
5 timeoutMs: 60_000,
6});
选项用途
apiKey请求认证,默认读取 JOY_TOKEN_API_KEY
apiBaseUrl模型列表等 JoyToken API 的 base URL
openAIBaseUrlOpenAI 兼容接口 base URL
timeoutMs请求超时时间
fetch自定义 fetch 实现

chat.completions.create

1await joytoken.chat.completions.create({
2 model: "auto",
3 messages: [{ role: "user", content: "Hello" }],
4});

调用 POST /openai/v1/chat/completions,返回非流式 Chat Completions 响应。

chat.completions.stream

1for await (const chunk of joytoken.chat.completions.stream({
2 model: "auto",
3 messages: [{ role: "user", content: "Hello" }],
4})) {
5 process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
6}

调用同一接口,使用 SSE 读取流式 chunks。

models.list

1const models = await joytoken.models.list();

调用 GET /api/v1/models

JoyTokenAPIError

1try {
2 await joytoken.models.list();
3} catch (error) {
4 if (error instanceof JoyTokenAPIError) {
5 console.error(error.status, error.requestId, error.body);
6 }
7}
字段用途
statusHTTP 状态码
requestId请求 ID
body错误响应体