DEVELOPER GUIDE

游戏素材生成与编辑 REST API 文档

通过谷灵AI REST API 创建角色、动画、场景与声音素材,了解 API Key 鉴权、生成参数、任务查询、下载权限、积分预算及失败处理。

接入方式

使用 API Key,在请求头传入 Authorization: Bearer YOUR_API_KEY。这里展示供外部工具使用的素材接口。

服务地址 https://www.gulingai.com/,请求时拼接下方接口路径。生成是否开放以模型查询结果为准,角色配音与游戏音效配置开通后可用。

公开接口

方法 / 路径用途权限
GET /v1/mcp/catalog素材类型与开放状态catalog:read
GET /v1/me本人账户信息account:read
GET /v1/credits/ledger本人积分流水account:read
GET /v1/provider-models模型与积分价格models:read
POST /v1/generations/quote生成与编辑报价generations:read
POST /v1/generations提交素材生成任务generations:write
POST /v1/generations/edit提交原图编辑任务generations:write
POST /v1/generations/repair修复动画单帧并创建新版本generations:write
GET /v1/generations最近任务列表generations:read
GET /v1/generations/:id任务状态与结果generations:read
POST /v1/generations/:id/cancel取消任务generations:write
POST /v1/assets/upload上传参考图assets:write
GET /v1/assets/:id素材信息assets:read
GET /v1/assets/:id/content下载素材assets:read

生成请求示例

{
  "max_credits": 5,
  "idempotency_key": "example-generation-001",
  "request": {
    "kind": "background",
    "prompt": "森林中的小镇,晨光透过树叶",
    "style": "手绘水彩",
    "width": 1024,
    "height": 1024,
    "params": {
      "transparent": false
    }
  }
}

将上述 JSON 作为 POST /v1/generations 请求体,无需先获取报价。图片固定 5 积分/次,精灵动作或动画特效固定 30 积分/次;角色配音固定 15 积分/次,使用音频生成模型,配置开通后可用。编辑图片在 request 中增加本人素材的 source_asset_id,并提交到 /v1/generations/edit。原报价接口保留兼容,quote_id 为可选字段。

类型与交付

类型支持 character、animation、background、element、button、tileset、building、vfx、voice、sound。动作需传入角色图片和 action,可选 idle/walk/run/attack/hurt/death,每次处理一个动作。按钮交付四个色彩状态;特效可选择动画或静态;动画特效通过视频模型交付帧序列和图集。request.params.output_duration 可指定 1–4 秒导出长度(支持小数),省略时自动提取动作或循环周期。ZIP 附带素材配置与校验信息。

角色方向

character 的 params.direction_count 支持 1(默认)、4、8;单方向参考图选填,四/八方向必须在 reference_asset_ids 选择一张参考图,不能使用图集。单方向通过 params.direction 选择 south/southwest/west/northwest/north/northeast/east/southeast(默认 east),多方向不传 direction。params.view 支持 side/top_down/isometric(默认 side)。多方向须使用透明背景,每张方向图 5 积分,完整四/八方向分别为 20/40 积分。交付独立方向 PNG、合并图集、含方向名称和切片坐标的 manifest.json 及 ZIP;参考图、合并图集和打包不另收费。全部交付后扣费,失败或取消释放整笔预留积分。

角色配音

voice 请求只需 kind、prompt(角色台词,最多 100 字)和 params,不需要画布或美术风格。params.voice_style 为声音描述(最多 500 字),language 为 zh-CN、en-US 或 ja-JP,speech_rate 为 0.5–2(默认 1),format 为 wav 或 mp3(默认 wav)。单次原始音频最长 120 秒,长台词建议分段。完成后支持在线播放、下载音频与素材包。

游戏音效

sound 请求只需 kind、prompt(音效描述)和 params。params.sound_duration 为目标时长 0.5–30 秒(默认 3),loop 为循环要求(默认 false),format 为 wav 或 mp3(默认 wav)。与配音共用音频生成模型;按目标时长计费,5 秒以内 10 积分,超出部分每秒增加 1 积分,不足 1 秒按 1 秒计算(5.5 秒为 11 积分,6.5 秒为 12 积分)。完成后可试听、循环播放和下载,实际时长与首尾衔接以交付音频为准。

动画修复、地图与平铺

角色动画每次仅调用一次视频生成,随后跟踪像素根点、对齐并生成质量报告。不满意时可自行重新生成,每次成功交付单独扣费。get_generation 的 result 包含 quality、alignment、candidates 和异常帧索引;工作台可逐帧播放和显示根点。POST /v1/generations/repair 或 MCP repair_animation_frame 传 generation_id、frame_index(从 0 开始)、instruction、max_credits(至少 5)与 idempotency_key,修复一帧后生成新的完整素材包,原版本保留。

地图块 params.tile_size 为 16/32/64/128,最多 1024 块;ZIP 附带 tileset.json(索引、切片坐标、视觉邻接规则)及拼接接缝预览。背景 params.tileable 可为 none/horizontal/vertical/both;输出四宫格平铺预览和 tiling.json 边缘检测报告。两类素材 params.seam_threshold 可设 0.001–0.3,默认 0.08。未通过的接缝会明确标记,可继续编辑原图。视觉邻接不替代地形语义与碰撞配置。

素材有效期与分页

素材生成或上传后有效期为 30 天,过期后不再提供预览、下载、编辑或参考使用;生成与计费记录保留,请及时下载保存。素材信息包含 expires_at(UTC 时间)。

GET /v1/generations 无参数时返回最近 50 条任务数组。传入 limit(1–50)、cursor、available_only、image_only 或 kind 时,返回 items 和 next_cursor;下一页使用返回的 next_cursor。MCP list_generations 支持相同参数。

响应与扣费

成功响应为 { data: ... };错误为 { error: { code, message } }。生成提交返回 202,轮询任务直至完成。图片、视频、音频和 ZIP 下载需要同一账户的 Key 并具备 assets:read 权限。

400 参数错误;401 鉴权失败;402 积分不足;403 权限不足;409 报价、幂等或预算冲突;429 频率限制;503 服务未配置或暂不可用。成功交付扣费,失败释放;相同任务查询和幂等重试不重复扣费。

项目素材生产与引擎导出

在 素材项目与套装 固定引擎版本、风格、色板、画布、枢轴点及纹理预算。网站、REST、MCP 使用同一套规范、任务、版本和积分记录。

  1. 调用 set_project_profile 创建规范;更新时传 project_id 与 expected_version,旧版本保留。
  2. 调用 plan_asset_bundle 创建免费计划,保存规范快照;动作可以通过 source_item_key 依赖前序角色,多方向须指定 source_direction。
  3. 核对 total / planned 费用,调用 submit_asset_bundle,传入 max_credits 和幂等键。系统逐项预留和结算,不预留整套费用、不自动付费重试。
  4. 用 get_bundle_report 查询;失败和暂停不会被查询触发重做。暂停后使用原预算和幂等键显式提交可继续;Key 失效后需用有权限的 Key 重新授权。
  5. 预览并用 review_bundle_item 记录人工验收。需要修改时调用原生成、编辑或单帧修复工具,再 select_bundle_item 替换指定项,旧版本保留。
  6. 调用 export_engine_bundle 导出当前或指定 revision。默认要求全部项通过技术检查且人工接受;项目测试可显式传 allow_unreviewed: true。

项目权限为 projects:read/write,套装权限为 bundles:read/write。执行套装还需 generations:write,替换需 generations:read,导出需 assets:read。已有 Key 不会自动增加权限,请创建包含所需权限的新 Key。

工具用途需要权限
set_project_profile创建项目或追加不可变美术规范版本;更新必须传 expected_version。不会生成或扣费。projects:write
list_projects列出本人素材项目,最多 50 项,支持游标。projects:read
get_project_profile读取本人项目及指定的不可变规范版本;省略 version 使用当前版本。projects:read
plan_asset_bundle免费创建不可变套装计划,最多 64 项。可用 source_item_key 依赖前序角色;多方向角色依赖须指定 source_direction。不会生成或冻结积分。bundles:write
list_asset_bundles列出本人套装摘要,支持项目筛选和游标;不会推进任务或扣费。bundles:read
submit_asset_bundle授权执行已规划套装。总费用不得超过 max_credits;逐项冻结和结算,不预留整套费用。仅执行一次,不自动付费重试;重启可恢复,Key 失效停止新任务。bundles:write、generations:write
get_bundle_report只读套装进度、费用、技术问题、人工验收和源版本;revision 可查看历史快照,不会触发生成。bundles:read
cancel_asset_bundle停止未提交项并取消未完成子任务,释放相应预留积分;已交付素材与扣费保留。bundles:write、generations:write
select_bundle_item用本人已完成且规格匹配的任务替换一个套装项,创建新修订并清除该项验收;不调用模型、不扣费。bundles:write、generations:read
review_bundle_item记录当前所选素材的人工验收(accepted/rejected/pending),创建套装修订。技术检测与美术验收分别记录。bundles:write
set_bundle_item_metadata设置动作事件、挂点及碰撞框并创建新修订。时间以秒计,坐标归一化且原点在画布左上角;这些数据由开发者定义,不从图片自动推断。修改后重新验收该项。bundles:write
export_engine_bundle免费导出指定修订的带扩边分页图集、清单、质量报告和 Unity/Cocos 接入源码;默认要求全部项人工接受且技术检查通过。allow_unreviewed=true 显式导出测试包;引擎源码仍须在目标版本编译实测。bundles:read、assets:read

套装计划示例

{
  "project_id": "prj_替换为本人项目ID",
  "name": "骑士基础动作",
  "items": [
    {
      "key": "hero",
      "request": {
        "kind": "character",
        "prompt": "穿红色披风的骑士,单个全身角色",
        "params": {
          "direction_count": 1,
          "direction": "east",
          "view": "side"
        }
      }
    },
    {
      "key": "idle",
      "source_item_key": "hero",
      "source_direction": "east",
      "request": {
        "kind": "animation",
        "prompt": "原地待机,平稳呼吸",
        "params": {
          "action": "idle",
          "fps": 12,
          "loop": true,
          "output_duration": 2
        }
      }
    }
  ]
}

将示例作为 plan_asset_bundle 参数,或 POST /v1/bundles/plan。project_id 替换为本人项目,规范画布须为不超过 512 的正方形。示例生成一个角色和一个待机动作,共 35 积分;计划本身不生成、不扣费。

局部修复与配置

upload_reference 可上传同尺寸 PNG 蒙版:白色为修改区、黑色为保护区,灰度乘透明度决定混合权重。静态原图编辑传 request.edit_mask_asset_id;repair_animation_frame 传 mask_asset_id。蒙版外保留原 RGBA 像素,蒙版修复动画时保留其他帧和画布,不重新对齐整套帧。工作台也支持画笔绘制修改区域。

set_bundle_item_metadata 设置秒制动作事件、挂点和碰撞框;坐标归一化,原点在画布左上角。这些信息由开发者定义,不根据图片自动推断。验收、替换和配置修改须传 expected_revision,版本冲突时先重新读取。

REST 对应接口

POST /v1/projectsset_project_profile
GET /v1/projectslist_projects
GET /v1/projects/:project_idget_project_profile
POST /v1/bundles/planplan_asset_bundle
GET /v1/bundleslist_asset_bundles
POST /v1/bundles/:bundle_id/submitsubmit_asset_bundle
GET /v1/bundles/:bundle_idget_bundle_report
POST /v1/bundles/:bundle_id/cancelcancel_asset_bundle
POST /v1/bundles/:bundle_id/selectselect_bundle_item
POST /v1/bundles/:bundle_id/reviewreview_bundle_item
POST /v1/bundles/:bundle_id/metadataset_bundle_item_metadata
POST /v1/bundles/:bundle_id/exportexport_engine_bundle

MCP 导出响应的 download.download_url 可直接供 Agent 下载 ZIP;create_asset_download 可为其他素材创建 5 分钟下载链接,无需读取长效 Key。Key 吊销后链接也失效。

交付与验证边界

ZIP 包含分页扩边图集、稳定帧标识、bundle.json、原交付配置、质量报告、SHA-256 校验清单和所选引擎的接入源码。矩形原点在左上角,pivot 在左下角,无旋转、无透明裁切。Unity 适配器需要 2D Sprite 包;Cocos 适配器提供 Sprite 播放组件。安装步骤见 ZIP 内 README.txt,资源更新时保留引擎生成的 .meta 文件。

技术检查不证明角色身份、动作语义、美术效果和实机性能合格。固定色板会处理可见像素颜色;提示词中的美术要求仍需人工检查。全部资源仍受 30 天有效期约束。下载后请归档,并在目标引擎和手机上完成编译、画面、资源更新与性能测试。