Developer reference / v1

API 信号手册

面向程序与智能体的生成接口。统一认证、异步任务、积分结算和安全交付。

01 / Quick start

发出第一条请求

API online

curl -X POST https://api.yourdomain.com/v1/tts \
  -H "Authorization: Bearer yb_xxx_yyy" \
  -H "Content-Type: application/json" \
  -d '{"text":"你好，欢迎使用 YB Studio。"}'

Bearer API Key

202 Async response

Presigned result URL

02 / Full reference

完整接口参考

# YB Studio API

自托管音视频生成平台。通过统一异步任务 API 提供文本转语音与音频驱动数字人视频生成。
积分为唯一消耗单位，异步任务模型。

Base URL: `https://api.yourdomain.com`

## 认证

所有生成接口使用 API Key 作为 Bearer Token：

```
Authorization: Bearer yb_<prefix>_<secret>
```

## 异步模型

POST 提交任务后返回 `job_id`，随后轮询 `GET /v1/jobs/{id}` 直到状态为
`succeeded`，再调用 `GET /v1/jobs/{id}/result` 获取下载链接。积分在提交时
预扣，完成时按实际用量结算，失败自动退款。

## POST /v1/tts — 文本转语音

```json
{
  "text": "你好，欢迎使用 YB Studio。",
  "voice_ref_key": "inputs/.../voice.wav",
  "emo_alpha": 1.0,
  "use_emo_text": false
}
```

## POST /v1/avatar — 音频驱动人像视频

```json
{
  "audio_ref_key": "inputs/.../audio.wav",
  "image_ref_key": "inputs/.../portrait.png",
  "prompt": "A woman speaking, bright studio",
  "resolution": "480p",
  "num_segments": 1
}
```

## POST /v1/avatar/from-text — 文本→语音→视频（一步）

```json
{
  "text": "大家好，这是数字人口播。",
  "image_ref_key": "inputs/.../portrait.png",
  "resolution": "720p"
}
```

## GET /v1/jobs/{id} — 查询任务状态
## GET /v1/jobs/{id}/result — 获取结果下载链接