Get started with Rodin
最后更新于
这有帮助吗?
最后更新于
这有帮助吗?
Rodin 的 API 使用 API 密钥来验证请求。要以编程方式访问 Rodin 服务,您需要生成一个 API 密钥。以下是如何安全地进行身份验证和使用 API 密钥的步骤。
导航到 API 密钥管理页面
登录到您的 Rodin 账户,进入 API 密钥管理部分。
点击“+创建新 API 密钥”按钮以生成新密钥。
安全存储您的 API 密钥
一旦创建,API 密钥将仅显示一次。确保您复制并安全存储。如果您丢失了密钥,您需要生成一个新密钥。
在必要时撤销密钥
您可以直接在 API 密钥管理页面管理现有的 API 密钥,并撤销不再需要的密钥。
对于每个 API 请求,请在 Authorization HTTP 头中包含 API 密钥。以下是如何构建请求的示例:
将 YOUR_RODIN_API_KEY
替换为您实际生成的 API 密钥。
一旦您生成了 API 密钥,就可以使用以下示例代码触发您的第一个请求,以生成高质量的 3D 资产。
当您向 Rodin API 发送 POST 请求时,服务器会返回一个 JSON 响应。以下是响应的结构及其组成部分的解释。
成功响应示例
响应中的字段
error: 如果请求成功,此字段将为 null。如果出现错误,则会包含描述错误的字符串。
message: 表示请求状态的字符串消息。对于成功的提交,这通常为 "Submitted."。
uuid: 您请求生成的任务的唯一标识符。此 uuid 用于跟踪整体任务。
jobs: 作业对象的数组。每个作业对象表示任务中的一个步骤,包括:
uuids: 每个作业的唯一标识符数组。每个作业对应于任务中的特定过程,例如模型生成或纹理生成。
subscription_key: 用于查询每个作业状态的密钥。此密钥允许您跟踪作业的进度和完成情况。
生成 API 是耗时且资源密集型的,因此我们将其设计为异步。这意味着您提交一个任务后不会立即获得结果。
作为一个快速示例,我们将展示如何获取下载结果的 URL 列表,假设您的任务已经准备好下载。
您将获得如下的 JSON 响应:
这是一个包含文件的数组,每个文件都有一个 url 用于下载,以及一个用户友好的 name。您可以使用浏览器或通过脚本程序下载这些文件。以下是一个 Bash 脚本示例,它使用 jq 解析返回结果,并通过后续调用 curl 下载文件。
在成功提交任务到 Rodin API 后,以下是一些推荐的后续步骤,以进一步探索 Rodin 的功能:
探索可调参数
跟踪进度
检索生成的资产
保持更新
通过 和 API 节点, 您可以检查已提交作业的状态并下载任务的结果。 建议您使用状态检查 API 以确保任务准备好下载,如我们在 中演示的,以避免意外结果。
查看我们的,了解更多用于 3D 资产生成的可调参数。微调您的请求,以通过各种可定制选项实现所需输出。
探索其他 Rodin 生成模型 探索我们其他,以找到最适合您需求的模型。由于默认层级是 Rodin Sketch,请考虑查看其他可能提供额外功能或更适合您项目要求的模型。
使用我们的 跟踪您的 3D 资产生成状态。监控每个作业,确保一切按预期进展。
一旦 3D 资产生成完成,请查询我们的 以打包和下载生成的资产。确保您拥有项目所需的所有文件。
关注我们的, ,和 获取 Rodin Gen-1 和 ChatAvatar 的最新更新。