# vimox-sdk

**Repository Path**: byshi2019/vimox-sdk

## Basic Information

- **Project Name**: vimox-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-23
- **Last Updated**: 2026-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vimox Router SDKs

官方维护的轻量级 Vimox Router 客户端集合。所有 SDK 均以
`https://router.vimox.cn` 为默认地址，并使用 API Key（`Authorization: Bearer`）鉴权。

| 语言 | 目录 | 安装 / 使用说明 |
| --- | --- | --- |
| Node.js / TypeScript | [`sdk/node`](sdk/node) | [README](sdk/node/README.md) |
| Python | [`sdk/python`](sdk/python) | [README](sdk/python/README.md) |
| Go | [`sdk/go`](sdk/go) | [README](sdk/go/README.md) |

请将 Key 放在环境变量中，勿提交到源代码：

```powershell
$env:VIMOX_API_KEY = '<your-api-key>'
```

SDK 覆盖 `/v1/models`、用量、OpenAI Chat/Responses、Anthropic Messages、Gemini、向量、图片、文件上传和异步视频任务。端点与模型约束请参阅 [`docs/api.txt`](docs/api.txt)。

对本地参考图、视频或音频，优先使用各 SDK 的 `generateWithReferences`、`createWithReferences`、`image_generate_with_references`、`video_create_with_references`、`ImageGenerateWithReferences` 或 `VideoCreateWithReferences`：SDK 先向 Router 获取短期预签名 PUT URL，再由客户端直传已配置的 COS，最后将公开 URL 交给目标模型。媒体字节不会经过 Router；调用者也无需管理 COS 密钥。

对本地参考图、视频或音频，优先使用各 SDK 的 `createWithReferences` / `video_create_with_references` / `VideoCreateWithReferences`：素材会先发送到 Router 的 `/v1/files/upload`，由服务器持久化到已配置的 COS，再将公开 URL 交给目标模型。调用者不应自行管理 COS 密钥。