Skip to content

快速开始​

欢迎使用 yuyuflow API 文档。本页是整个开放平台的统一入门指南,帮助你从注册账号、准备凭证开始,快速找到图片、视频、音乐、TTS、素材库等能力的接入文档。

平台能力概览​

根据业务场景选择对应的文档入口:

能力适用场景接入入口
图片接入图片生成、参考图编辑、结果解析与异步接入方法图片接入指南
视频生成文生视频、图生视频、视频查询和超分视频生成文档
音乐生成音乐、音效、歌词、续写和音频处理Suno 音乐与音频处理接入指南
TTS / 语音文本转语音和语音模型调用Fish Audio TTS API
人像与素材真人/虚拟人像及素材资产管理人像与素材文档
LLM聊天补全、模型选择和通用客户端配置LLM 配置
CLI / Agent 工具Codex、Claude Code、OpenCode、OpenClaw、Hermes、Reasonix、WorkBuddy / CodeBuddy 和统一配置切换Agent 工具总览

开始前准备​

  • 一个可登录 控制台 的账号。
  • 一个有余额或可用额度的账号。
  • 根据目标能力准备对应的访问凭证。
  • 明确要调用的模型、接口版本和输出格式。

第一步:注册并登录账号​

如果还没有账号,请在 控制台 完成注册。注册后登录控制台,确认当前账号、工作区和计费状态正常。

不同工作区创建的凭证可能具有不同的模型访问权限,请在后续操作中保持工作区一致。

第二步:检查额度并开通能力​

在控制台检查可用额度,并确认目标模型或服务处于可用状态。调用前请确认:

  • 账号余额或套餐额度足够。
  • 目标模型已开通,且名称与控制台显示一致。
  • 当前凭证所属的令牌分组包含目标能力。
  • 如果使用素材库 API,已准备好对应的 AK/SK 权限。

第三步:创建访问凭证​

在控制台的 API Key、令牌管理或访问密钥页面创建专用凭证。建议为开发、测试、生产环境以及不同项目分别创建凭证,便于权限控制、成本隔离和问题排查。

API Key 鉴权​

视频、音乐、TTS 接口通常使用 API Key:

text
Authorization: Bearer YOUR_API_KEY

AK/SK 鉴权​

素材库管理接口使用 Access Key(AK/SK)签名。具体签名流程和权限配置请阅读素材库 Python SDK。

凭证安全要求

不要把真实 API Key、AK/SK 提交到公开仓库、前端代码、日志、Issue 或截图中。生产环境请使用服务端环境变量或密钥管理服务。

第四步:选择接入方式​

直接调用 API​

适合服务端程序或需要完全控制请求参数的场景。先阅读对应能力的 API 文档,再使用 cURL 验证地址、鉴权和模型。

使用 SDK​

适合在 Python、Node.js 等项目中集成。SDK 的 base_url、API Key 和模型名仍需要根据对应 API 文档配置。

使用 CLI 工具​

如果你使用 Codex、Claude Code、OpenCode、OpenClaw、Hermes、Reasonix 或 WorkBuddy / CodeBuddy,推荐先阅读 Agent 工具总览,再按工具进入 CC-Switch 配置、Codex 配置、Claude Code 配置、OpenCode 配置、OpenClaw 配置、Hermes 配置、Reasonix 配置 或 WorkBuddy / CodeBuddy 配置。

第五步:发起第一次请求​

建议选择目标能力对应的最小请求验证连通性。图片、视频、音乐、TTS 和素材接口请使用各自页面中的请求示例。图片接口的路由与鉴权请先按图片接入指南确认。

LLM 请求示例​

将 YOUR_API_KEY 和 YOUR_MODEL 替换为控制台中的实际值。

curl -X POST "https://art-api.yuyuflow.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_MODEL",
    "messages": [
      {"role": "user", "content": "你好,请用一句话介绍自己。"}
    ]
  }'
import os
import requests

response = requests.post(
    os.environ.get("API_BASE_URL", "https://art-api.yuyuflow.com") + "/v1/chat/completions",
    headers={
        "Authorization": f"Bearer {os.environ['API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "model": os.environ.get("MODEL", "YOUR_MODEL"),
        "messages": [{"role": "user", "content": "你好,请用一句话介绍自己。"}],
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://art-api.yuyuflow.com/v1/chat/completions", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: process.env.MODEL || "YOUR_MODEL",
    messages: [{ role: "user", content: "你好,请用一句话介绍自己。" }],
  }),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

如果 https://art-api.yuyuflow.com 已经包含 /v1,请删除示例地址中额外的 /v1,避免重复拼接。

视频请求示例​

将 YOUR_API_KEY 和 YOUR_VIDEO_MODEL 替换为控制台中的实际值:

bash
curl -X POST "https://art-api.yuyuflow.com/api/v3/contents/generations/tasks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "YOUR_VIDEO_MODEL",
    "content": [
      {"type": "text", "text": "一只橘猫坐在窗边,清晨自然光"}
    ]
  }'

按能力继续阅读​

调用失败排查清单​

  1. 确认请求地址、协议和接口版本正确。
  2. 确认使用了正确的鉴权方式:API Key 或 AK/SK,不能混用。
  3. 确认 API Key 未过期,或 AK/SK 具有目标素材接口权限。
  4. 检查账号余额、请求超时和服务状态。
  5. 先用对应页面中的 cURL 请求复现,再迁移到 SDK。