⌘K

Spark 3D

spark_3d

3D 内容生成,从文本或图像生成结构化资产,可用于下游生产工作流程

认证

authorization string 必需

所有 API 均使用 Bearer Token 鉴权

获取 API Key:

访问 API Key 管理页面 获取 API Key

用法:

将以下 Header 添加到请求中:

Authorization: Bearer YOUR_API_KEY

参数

model string 必需

请求使用的模型 ID

: spark_3d


content array 必需

输入给模型, 用于生成 3D 文件的信息. 必须包含至少 2 个项目: 文本内容和图像内容

文本内容对象

type string 必需

内容类型

: text

text string 必需

输入给模型的文本内容, 包括:

参数(选填): 通过 --[parameters] 的方式, 控制 3D 文件输出的规格, 详情见模型文本命令(选填)

图像内容对象

type string 必需

内容类型

: image_url

image_url object 必需

图片 URL 对象

url string 必需

图片信息, 可以是图片 URL 或图片 Base64 编码

图片 URL: 请确保图片 URL 可被访问

Base64 编码: 请遵循此格式 data:image/<图片格式>;base64,<Base64编码>, 注意 <图片格式> 需小写, 如 data:image/png;base64,{base64_image}

图片要求:
总像素: 小于 4096×4096 px
大小: 小于等于 10MB
格式支持: jpg, jpeg, png, webp, bmp


模型文本命令(选填)

控制 3D 文件输出的规格

示例:

"content": [
    {
        "type": "text",
        "text": "--subdivisionlevel medium --fileformat obj"
    }
]

subdivisionlevel string

3D 文件中多边形面的数量

默认值: medium

简写: sl

可选值: high, medium, low

  • high: 200000 面(new)
  • medium: 100000 面
  • low: 30000 面(new)

fileformat string

生成的 3D 文件格式

默认值: glb

简写: ff

可选值: glb, obj, usd, usdz


轮询

由于 3D 模型生成需要时间, 您需要在创建任务后轮询任务状态

初始响应返回任务 ID 和初始状态. 实际的生成结果必须通过轮询任务状态端点来获取

响应格式

error object

错误信息. 仅在状态为 failed 时出现

code string

错误码

error_message string

详细错误信息


output array

生成结果. 仅在状态为 completed 时出现

content array

生成的 3D 模型内容列表

type string

资源类型

: glb

url string

生成的 3D 模型文件 URL(已处理并上传至 CDN)

jobId string

远程任务 ID


usage object

使用统计. 仅在状态为 completed 时出现

cost string

总费用(美元)

discount number

折扣金额

input_tokens integer

输入 Token 数量(实际为 prompt_tokens)

output_tokens integer

输出 Token 数量(实际为 completion_tokens)

total_tokens integer

总 Token 数量

created_at integer

任务创建时间戳

updated_at integer

任务更新时间戳


metadata object

元数据信息


错误码

错误码描述
003020001缺少文本提示词
003020002缺少图片 URL
003020003细分级别无效
003020004文件格式无效
003020005图片 URL 格式无效
003020095内部生成错误
003020096结果解析异常
003020097HTTP 错误响应
003020098状态检查异常
003020099任务创建异常