Skip to main content
每个项目都有活动设置——裁剪、背景、字幕样式、布局——用于控制导出如何渲染。当你需要项目本地的覆盖项、但又不值得作为预设共享时,请使用项目设置。 共享的 presetsettings.stylesettingsOverride 字段映射请参见 渲染设置参考

端点

方法路径用途
GET/projects/{projectId}/settings获取当前活动的项目设置。
PATCH/projects/{projectId}/settings应用预设、修补设置,或同时执行两者。
完整的请求与响应 schema 请见 API reference

获取当前设置

curl https://api.youka.io/zh/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..."
返回完整的活动项目设置,包括已应用的任何预设。

修补设置

PATCH 接受 presetIdsettings 的任意子集。当两者同时传入时,会先应用预设,然后将 settings 合并覆盖在其之上。
curl -X PATCH https://api.youka.io/zh/api/v1/projects/prj_abc/settings \
  -H "Authorization: Bearer yk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "presetId": "preset_abc123"
  }'

发现有效字段

SDK 导出了用于校验项目设置更新的 schema。可在运行时将其转换为 JSON Schema:
import { RestUpdateProjectSettingsRequestSchema } from "@youka/sdk";

const schema = RestUpdateProjectSettingsRequestSchema.toJSONSchema();
Agents 在变更项目设置之前,应先获取 SDK schema 或 OpenAPI 请求 schema,以确保始终了解当前的数据结构。
便于阅读的参考:

项目设置 vs 预设 vs 导出覆盖项

Youka 有三个层级可承载渲染设置:
层级作用域何时使用
Preset账号范围在多个项目中保持相同的外观。
Project settings单个项目项目特定的裁剪、背景或颜色。
Export settingsOverride仅单次导出调整一次渲染效果而不影响项目本身。
在导出时会按该顺序逐层合并。

接下来