xBookvideo API

图书转视频 SaaS API — 上传图书，自动分集规划，AI 生成短视频。

Base URL: https://xbookvideo.com Version: 1.0.0

认证方式

# 方式 A: X-API-Key header
curl -H "X-API-Key: xbk_your_api_key_here" \
  https://xbookvideo.com/api/v1/auth/me

# 方式 B: Authorization Bearer
curl -H "Authorization: Bearer xbk_your_api_key_here" \
  https://xbookvideo.com/api/v1/auth/me

curl -H "Authorization: Bearer " \
  https://xbookvideo.com/api/v1/auth/me

限流规则

限流响应包含以下 header：

X-RateLimit-Limit: 10
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1721820000

超出限制时返回 429 Too Many Requests。

API 端点列表

认证 & API Key

图书上传 & 写书

分集规划 & 渲染

视频 & 下载

支付

分享 & 压缩

知识索引 & 搜索

Google Books & 公有领域

代码示例

Python

import httpx

API_KEY = "xbk_your_api_key_here"
BASE_URL = "https://xbookvideo.com"

# 1. 上传图书
with open("book.pdf", "rb") as f:
    resp = httpx.post(
        f"{BASE_URL}/api/v1/upload",
        headers={"X-API-Key": API_KEY},
        files={"file": ("book.pdf", f, "application/pdf")},
    )
    project_id = resp.json()["project_id"]

# 2. 生成分集规划
httpx.post(
    f"{BASE_URL}/api/v1/plan",
    headers={"X-API-Key": API_KEY, "Content-Type": "application/json"},
    json={"project_id": project_id, "total_episodes": 12},
)

# 3. 轮询规划进度
import time
while True:
    status = httpx.get(
        f"{BASE_URL}/api/v1/projects/{project_id}/status",
        headers={"X-API-Key": API_KEY},
    ).json()
    if status["status"] in ("planned", "demo_ready", "completed"):
        break
    time.sleep(5)

# 4. 生成 Demo
httpx.post(
    f"{BASE_URL}/api/v1/generate-demo",
    headers={"X-API-Key": API_KEY, "Content-Type": "application/json"},
    json={"project_id": project_id, "episode_indices": [0, 1]},
)

# 5. 获取视频列表
videos = httpx.get(
    f"{BASE_URL}/api/v1/projects/{project_id}/videos",
    headers={"X-API-Key": API_KEY},
).json()
for v in videos["videos"]:
    print(f"Episode {v['episode']}: {v['title']} ({v['duration']:.0f}s)")

cURL — 创建 API Key

# 先用 JWT 登录获取 token
TOKEN=$(curl -s -X POST https://xbookvideo.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"your_username","password":"your_password"}' \
  | python3 -c "import sys,json; print(json.load(sys.stdin)['token'])")

# 创建 API Key
curl -X POST https://xbookvideo.com/api/v1/api-keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My Production Key","scopes":"read,write,render"}'

# 列出 API Keys
curl https://xbookvideo.com/api/v1/api-keys \
  -H "Authorization: Bearer $TOKEN"

JavaScript (Node.js)

const API_KEY = "xbk_your_api_key_here";
const BASE = "https://xbookvideo.com";

// 上传图书
const formData = new FormData();
formData.append("file", fs.createReadStream("book.pdf"));

const uploadRes = await fetch(`${BASE}/api/v1/upload`, {
    method: "POST",
    headers: { "X-API-Key": API_KEY },
    body: formData,
});
const { project_id } = await uploadRes.json();

// 生成分集规划
await fetch(`${BASE}/api/v1/plan`, {
    method: "POST",
    headers: {
        "X-API-Key": API_KEY,
        "Content-Type": "application/json",
    },
    body: JSON.stringify({ project_id, total_episodes: 12 }),
});

// 查询进度
const status = await fetch(
    `${BASE}/api/v1/projects/${project_id}/status`,
    { headers: { "X-API-Key": API_KEY } }
).then(r => r.json());
console.log("Status:", status.status, "Progress:", status.progress);

错误码

xBookvideo API · Interactive Swagger Docs · ← Back to App