Apiz

Apiz CLI 完全参考

全局参数

所有命令共享以下全局 flags：

所有命令速查

generate 生成命令详解

apiz generate "<prompt>" [flags]

全部参数

--image-url 用于多种输入场景：图生图、图生视频、声音克隆（输入音频样本）、语音识别（输入音频文件）。--params 可传入任意额外的模型参数，会与标准参数合并。

输出格式

成功时返回：

{
  "task_id": "xxx",
  "status": "completed",
  "model": "openai/gpt-image-2",
  "result": {
    "images": [{
      "url": "https://cdn-hk.51sux.com/...",
      "content_type": "image/png",
      "width": 1122,
      "height": 1402
    }]
  },
  "price": 64,
  "created_at": "2026-07-30 19:28:30",
  "completed_at": "2026-07-30 19:29:15"
}

视频结果中 result 可能包含 video 字段替代 images。失败时 status 为 "failed" 且携带 error 字段。

完整命令参考

1. 安装与登录

# 安装 CLI
curl -fsSL https://apiz.ai/cli | sh

# 写入 API Key 到配置文件
apiz auth login --api-key "sk-xxx"

# 配置文件位置：~/.config/apiz/config.toml

API Key 优先级：--api-key 参数 > APIZ_API_KEY 环境变量 > XSKILL_API_KEY 环境变量 > 配置文件

2. 模型查询

# 按分类列出可用模型
apiz models list --category image --json
apiz models list --category video --json
apiz models list --category audio --json

# 查看模型详情（含参数 schema）
apiz models info image4.0 --lang zh --json

# 查看模型使用教程
apiz models docs image4.0 --lang zh

模型列表字段含义：

• id — 模型 ID（用于 generate 的 --model）
• name — 中文名称
• category — 分类（image/video/audio）
• capability — 能力描述
• stats.success_rate — 历史成功率
• stats.pending_tasks — 排队任务数
• stats.processing_tasks — 处理中任务数
• isHot — 热门模型标记
• pricing — 价格信息

models info 还会返回：

• description — 模型详细描述
• params_schema — 模型支持的参数 schema
• channel — 执行通道

3. 图片生成

# 基础文生图
apiz generate "一只可爱的猫" --model image4.0 --wait --json

# 指定画面比例
apiz generate "山峰日落，4K 画质" --model openai/gpt-image-2 --aspect-ratio "16:9" --wait --json

# 图片编辑（提供输入图片 + 修改描述）
apiz generate "把背景换成沙滩，保留人物" --model openai/gpt-image-2/edit --image-url "https://..." --wait --json

# ChatGPT Images 2.0 高质量生成（成功率 ~97%）
apiz generate "赛博朋克风格的城市夜景" --model openai/gpt-image-2 --wait --json

# Nano Banana Pro（Google 高级版）
apiz generate "水墨风格的山水画" --model fal-ai/nano-banana-pro --wait --json

4. 视频生成

# 文生视频
apiz generate "一只金毛在沙滩上奔跑" --model st-ai/super-seed2-lite --wait --json
apiz generate "日落时分的城市延时摄影" --model fal-ai/kling-video/v3/pro/text-to-video --wait --json

# 图生视频
apiz generate "让这张图片的场景动起来，微风吹过" --model fal-ai/kling-video/v3/pro/image-to-video --image-url "https://..." --wait --json

# 多图参考视频
apiz generate "参考这些图片的风格和构图生成视频" --model apiz/veo3.1/reference-to-video --wait --json

# 动作迁移（参考视频的动作应用到目标）
apiz generate "按参考视频的动作生成" --model fal-ai/kling-video/v3/standard/motion-control --image-url "https://..." --wait --json

# Kling O3 Pro 图生视频（成功率 100%）
apiz generate "让照片变成生动的短视频" --model fal-ai/kling-video/o3/pro/image-to-video --image-url "https://..." --wait --json

# Sora 2 文生视频（OpenAI）
apiz generate "科幻风格的太空站内部" --model apiz/sora-2/text-to-video --wait --json

# Veo 3.1 文生视频（Google 快速版）
apiz generate "野生动物纪录片风格的画面" --model apiz/veo3.1/fast/text-to-video --wait --json

5. 视频处理

# 解析视频分享链接 -> 获取无水印下载地址 (免费)
apiz parse "https://www.douyin.com/video/xxx"

# 返回: platform, title, video_url, cover_url, duration

# URL 镜像到 apiz CDN (免费)
apiz transfer "https://example.com/video.mp4" --type image

# 返回: original_url, cdn_url, type, size_bytes

# 火山 VOD 精细化字幕擦除
apiz generate "" --model volcengine/vod/subtitle-erase --image-url "<视频url>" --wait --json

6. 语音合成 (TTS)

# 列出可用音色
apiz voices list --json

# 语音合成（默认音色）
apiz speak "你好，欢迎使用AI语音合成服务" --json

# 指定音色
apiz speak "今天天气真不错" --voice "<voice-id>" --json

# 指定语速 + 模型
apiz speak "这是一条测试语音" --voice "<voice-id>" --speed 1.2 --model "speech-2.8-hd" --json

# 保存到本地文件
apiz speak "保存这段语音到文件" --output-file "output.mp3"

# TTS 模型选项：
# speech-2.8-hd     - 高清语音（默认）
# speech-2.8-turbo  - 快速语音
# speech-2.6-hd     - 高清语音 v2.6
# speech-2.6-turbo  - 快速语音 v2.6

# 语音设计（创建自定义音色）- 通过 SDK 支持
# SDK: client.voices.design({ prompt: "年轻女性，温柔语气" })

# 声音克隆（基于音频样本）
# CLI: 使用 apiz generate --model minimax/voice-clone --image-url "<样本音频url>"

7. 强制对齐 / 字幕打轴

# 说话字幕对齐
apiz align "如果您没有其他需要举报的话..." \
  --audio "https://example.com/talk.mp3" \
  --mode speech --json

# 唱歌字幕对齐
apiz align "曾经真的以为人生就这样了" \
  --audio "https://example.com/song.mp3" \
  --mode singing --json

# 保存结果到文件
apiz align "文本内容" \
  --audio "https://example.com/audio.mp3" \
  --mode speech \
  --output-file "result.json"

# 对齐参数
# --mode        : speech (默认) | singing
# --punct-mode  : 0 (=> 1), 1, 2, 3
# --interval    : 轮询间隔（默认 2s）
# --wait-timeout: 超时（默认 5m）

# 返回结构
# {
#   "duration": 120.5,
#   "utterances": [{
#     "text": "句子文本",
#     "start_time": 1000,
#     "end_time": 3000,
#     "words": [{
#       "text": "词",
#       "start_time": 1000,
#       "end_time": 1200
#     }]
#   }]
# }

8. 音频识别与音乐生成

# 语音识别（录音文件转文字）
apiz generate "" --model volcengine/speech-to-text/bigmodel-v2 --image-url "<音频文件url>" --wait --json

# 音乐生成
apiz generate "一首轻快的钢琴曲，温暖治愈风格" --model minimax/music-gen --wait --json
apiz generate "电子舞曲，节奏感强，适合运动" --model minimax/music-gen --wait --json

9. 文件上传

# 上传本地文件到 apiz CDN
apiz upload "./image.png"
apiz upload "./audio.mp3" --folder "my-uploads" --remark "demo"

# 上传参数
# --folder       : 存储文件夹（默认 cli-uploads）
# --content-type : MIME 类型（自动检测）
# --remark       : 备注
# --uploader     : 上传者标签

# 返回：public_url, file_key, file_name, file_size, content_type

10. 任务管理

# 查询任务状态
apiz tasks get "task-id-xxx"

# 等待任务完成
apiz tasks wait "task-id-xxx" --interval 3s --wait-timeout 5m

# 任务状态：
# pending    - 排队中
# processing - 处理中
# completed  - 已完成
# failed     - 失败（含 error 信息）

# TaskResponse 完整结构：
# {
#   "task_id": "xxx",
#   "status": "pending|processing|completed|failed",
#   "channel": "api",
#   "model": "model-id",
#   "progress": 0.5,
#   "result": { ... },
#   "queue_info": { ... },
#   "error": "错误信息",
#   "price": 64,
#   "created_at": "2026-07-30 19:28:30",
#   "completed_at": "2026-07-30 19:29:15"
# }

11. 账户管理

# 查余额
apiz account balance

# 每日签到（随机 50-150 积分，每天一次，幂等）
apiz account checkin

模型参考

图片生成模型（6 个）

视频生成模型（24 个）

Kling 系列（快手可灵，fal.ai）

Seedance / Super Seed 系列（火山引擎）

Grok Imagine Video 系列（xAI）

Sora 2 系列（OpenAI，APIZ 代理）

Veo 3.1 系列（Google，APIZ 代理）

其他

音频模型（7 个）

API 兼容模式

apiz 提供 OpenAI 兼容的 /v1/chat/completions 接口：

from openai import OpenAI
client = OpenAI(
    base_url="https://api.apiz.ai/v1",
    api_key="sk-xxx"
)
# 可调用数百种对话模型
response = client.chat.completions.create(
    model="anthropic/claude-sonnet-4.6",
    messages=[{"role": "user", "content": "hello"}]
)

可用对话模型通过 GET https://api.apiz.ai/v1/models 查询，包含 GPT、Claude、Gemini、Qwen、DeepSeek 等数百种。

SDK 方式

apiz 提供官方 SDK：TypeScript (npm install apiz-sdk)、Python (pip install apiz)。

from apiz import Apiz
client = Apiz(api_key="sk-xxx")

# 生成（参数通过 params 字典传入）
result = client.generate(
    model="image4.0",
    params={"prompt": "a cat", "aspect_ratio": "16:9"},
)

# 语音合成（返回 audio_url / duration）
result = client.speak("你好", voice_id="xxx")

# 强制对齐（返回字级时间戳）
result = client.align(
    audio_url="https://...",
    audio_text="歌词文本",
    mode="singing",
)

# 查看余额
balance = client.account.balance()

完整 SDK 方法映射见 references/sdk-api-reference.md。

MCP Server

apiz 提供 MCP Server 可在 Cursor / Claude Desktop 中使用：

{
  "mcpServers": {
    "apiz": {
      "command": "npx",
      "args": ["-y", "apiz-mcp"],
      "env": { "APIZ_API_KEY": "sk-..." }
    }
  }
}

提供 9 个工具：generate, get_result, search_models, guide, account, speak, align, parse_video, transfer_url。完整说明见 references/mcp-server.md。