> ## Documentation Index
> Fetch the complete documentation index at: https://docs.viggle.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 从自定义全景图创建场景
> 用你自己的 360° 全景图构建 3D 场景，并按指定位姿和比例放入你的世界。
与用 `panoramaUri` 或上传的 `panorama` 文件调用[创建场景](/zh/v1/api-reference/scenes/pano)类似，但还要说明全景图在你自己世界中的拍摄位置：`panoramaC2w` 是它的相机位姿，`metersPerUnit` 是场景模型坐标系与你的坐标系之间的比例。结果中的所有相机——现在批次中的视图，以及之后[生成](/zh/v1/api-reference/scenes/generate)的新视图——都以你的世界坐标系返回，因此场景能与你已有的内容对齐。
该任务属于 `pano` 任务：[查询场景任务](/zh/v1/api-reference/scenes/get)会返回 `operation: "pano"`，结果也相同。
**计费**（1 积分 = \$0.01）：每个任务 **1 积分（\$0.01）**，提交时预扣，任务未以 `ready` 结束则全额退回。见[计费](/zh/v1/pricing#scene-model)。
## 请求参数
使用 `application/json`，最大 1 MiB；如需直接上传全景图文件，改用 `multipart/form-data`，见下方“上传全景图文件”一节。不接受未知字段。
| 参数 | 类型 | 必填 | 默认值 | 说明 |
| - | - | :-: | - | - |
| `sessionId` | string | 是 | — | 构建场景所在的会话，见[创建场景](/zh/v1/api-reference/scenes/pano)中的“会话”一节。 |
| `panoramaUri` | string | `panoramaUri` / `panorama` 二选一 | — | 360° 全景图的 URL，须符合[创建场景](/zh/v1/api-reference/scenes/pano)中的 URL 规则。 |
| `panorama` | file | `panoramaUri` / `panorama` 二选一 | — | 以文件形式上传的 360° 全景图，JPEG、PNG 或 WebP，最大 50 MiB。仅限 multipart，见下方“上传全景图文件”一节。 |
| `panoramaC2w` | number\[4]\[4] | 是 | — | 全景图在你的世界中的相机到世界矩阵（c2w），见下方“坐标系”一节。 |
| `metersPerUnit` | number | 否 | `1` | 在 `panoramaC2w` 把场景模型的坐标变换到你的世界之前，先对其应用的比例，见下方“坐标系”一节。不小于 `0.05`。 |
| `spzOutputUrl` | string | 否 | — | 你自己的 `.spz` 场景上传地址，见[创建场景](/zh/v1/api-reference/scenes/pano)中的“上传到自己的存储”一节。 |
| `outputUris` | object | 否 | — | 按文件指定你自己的上传地址：`spz`、`preview`、`panorama`。不能与 `spzOutputUrl` 同时使用。 |
本接口不接受 `prompt`、`referenceImages` 和 `quality`。
### 上传全景图文件
以 `multipart/form-data` 发送请求，并把图片放在名为 `panorama` 的文件字段中，规则与[创建场景](/zh/v1/api-reference/scenes/pano)中的“上传全景图文件”一节相同：
* 其他字段与 JSON 请求体相同，每个只能发送一次。`sessionId` 和 `spzOutputUrl` 是普通文本；`panoramaC2w`、`metersPerUnit` 和 `outputUris` 以文本形式携带其 JSON 值，例如 `panoramaC2w=[[1,0,0,0],[0,1,0,1.5],[0,0,1,0],[0,0,0,1]]`。
* 最多发送一个文件，且必须命名为 `panorama`：1 字节到 50 MiB，按文件内容识别为 JPEG、PNG 或 WebP 图片。
* 该文件取代 `panoramaUri`，二者同时发送会被拒绝。
* 计费与使用 `panoramaUri` 构建场景相同。
## 坐标系
`panoramaC2w` 是一个 4 × 4 的相机到世界矩阵，按四行书写：
* 最后一行必须为 `[0, 0, 0, 1]`。
* 左上角 3 × 3 旋转部分必须正交归一（无缩放、无切变），且为真旋转（行列式为 `+1`，无镜像），容差 `1e-4`。
* 平移部分（第四列的前三个值）是全景图在你的世界中的位置，单位为你的单位。
* 场景必须在 `.spz` 可存储的范围内：平移分量的最大绝对值加上 `25 × metersPerUnit`（场景半径）必须小于 `4000`。
场景模型坐标系中的点 `p` 在你的坐标系中位于 `R · (metersPerUnit · p) + t`，其中 `R` 和 `t` 是 `panoramaC2w` 的旋转和平移。结果中的相机也按同样方式转换。
## 响应参数
返回 `200 OK` 和 `queued`（或已经是 `processing`）状态的场景任务，`operation` 为 `pano`：
```json theme={null}
{
"id": "scn_0199f0c2-6a1e-7c3d-9b2a-4f5e6d7c8b9a.atrium-01",
"sessionId": "atrium-01",
"operation": "pano",
"status": "queued",
"credits": 1,
"queuePosition": 0,
"createdAt": 1791856740000,
"completedAt": null,
"result": null,
"error": null
}
```
## 常见错误
| 错误 | 原因 |
| - | - |
| `400 INVALID_REQUEST` | 字段缺失、不合法或未知；`panoramaC2w` 不是有效位姿；`metersPerUnit` 小于 `0.05`；场景会超出坐标范围；或某个 URL 不符合[创建场景](/zh/v1/api-reference/scenes/pano)中的 URL 规则。 |
| `400 INVALID_REQUEST`（multipart） | 表单格式错误、某个字段发送了多次、JSON 字段不是合法 JSON、发送了 `panorama` 以外或多于一个的文件，或全景图超过 50 MiB 或不是 JPEG、PNG、WebP 图片。 |
| `401 UNAUTHENTICATED` | 缺少或无效的 API 密钥。 |
| `402 INSUFFICIENT_CREDITS` | 余额不足以支付该任务，任务不会进入队列。 |
| `408 UPLOAD_TIMEOUT` | multipart 上传未能在时限内传完，可重试。 |
| `409 INVALID_REQUEST` | 该会话已有任务处于 `queued` 或 `processing`，见 `error.details.running_task_id`。 |
| `429 RATE_LIMITED` | 同一密钥的并发提交过多，请稍后重试。 |
| `503 SERVICE_BUSY` | 场景模型暂时不可用，可重试。 |
## 示例
一张在原点上方 1.5 个单位处拍摄、绕 y 轴旋转 90° 的全景图，使用默认比例：
```bash cURL theme={null}
curl -X POST https://apis.viggle.ai/v1/scenes/custom-pano \
-H "Authorization: Bearer $VIGGLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "atrium-01",
"panoramaUri": "https://example.com/atrium-360.jpg",
"panoramaC2w": [[0, 0, 1, 0], [0, 1, 0, 1.5], [-1, 0, 0, 0], [0, 0, 0, 1]]
}'
```
```python Python theme={null}
import os, requests
response = requests.post(
"https://apis.viggle.ai/v1/scenes/custom-pano",
headers={"Authorization": f"Bearer {os.environ['VIGGLE_API_KEY']}"},
json={
"sessionId": "atrium-01",
"panoramaUri": "https://example.com/atrium-360.jpg",
"panoramaC2w": [[0, 0, 1, 0], [0, 1, 0, 1.5], [-1, 0, 0, 0], [0, 0, 0, 1]],
},
)
response.raise_for_status()
task = response.json()
```
```javascript JavaScript theme={null}
const response = await fetch("https://apis.viggle.ai/v1/scenes/custom-pano", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.VIGGLE_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
sessionId: "atrium-01",
panoramaUri: "https://example.com/atrium-360.jpg",
panoramaC2w: [[0, 0, 1, 0], [0, 1, 0, 1.5], [-1, 0, 0, 0], [0, 0, 0, 1]],
}),
});
const task = await response.json();
```
同一请求改为上传本地全景图文件，使用 `multipart/form-data`：
```bash theme={null}
curl -X POST https://apis.viggle.ai/v1/scenes/custom-pano \
-H "Authorization: Bearer $VIGGLE_API_KEY" \
-F sessionId=atrium-01 \
-F 'panoramaC2w=[[0, 0, 1, 0], [0, 1, 0, 1.5], [-1, 0, 0, 0], [0, 0, 0, 1]]' \
-F panorama=@atrium-360.jpg
```
用[查询场景任务](/zh/v1/api-reference/scenes/get)轮询，然后用[生成场景视图](/zh/v1/api-reference/scenes/generate)和[重建场景](/zh/v1/api-reference/scenes/reconstruct)继续该会话。
## OpenAPI
````yaml zh/openapi.yaml POST /v1/scenes/custom-pano
openapi: 3.0.3
info:
title: Viggle API
description: 使用 AI 生成角色动画视频。
version: 2.0.0
contact:
name: Viggle Support
url: https://viggle.ai
servers:
- url: https://apis.viggle.ai
description: 生产服务器
security:
- bearerAuth: []
tags:
- name: Renders
description: 准备输入、创建渲染、观察进度并获取结果。
- name: Credits
description: 查询当前调用者可用的积分余额。
- name: Characters
description: 创建、列出、查询和删除可复用角色。type 决定是否同时提取 3D vsplat，就绪后通过导出接口获取下载链接。
- name: Motions
description: 创建、列出、查询和删除可复用动作，也可从官方模板导入。type 决定是否提取或生成 3D 动画，就绪后通过导出接口获取下载链接。
- name: Videos
description: 生成 MiniMax H3 视频（vid_）或角色动画视频（anim_），并统一查询调用者的 H3、角色动画及角色动作渲染（render_）结果。
- name: Images
description: Viggle Image：用 qwen 模型从文字描述生成 1–6 张 PNG（img_），可选最多 8 张参考图，并按 ID 查询结果。
- name: Scenes
description: >-
场景模型：从文字描述或 360° 全景图构建 3D 高斯泼溅场景（`.spz`），生成新的带位姿视图，并据此重建场景。所有操作都是异步任务（以
`scn_` 开头），按 ID 查询。从文字描述创建场景每个任务 6 积分，其他场景任务每个 1 积分；任务未以 `ready` 结束时全额退回。
paths:
/v1/scenes/custom-pano:
post:
tags:
- Scenes
summary: 从自定义全景图创建场景
description: >
与使用 `panoramaUri` 或上传 `panorama` 文件（`multipart/form-data`）的 `pano`
相同，但全景图按 `panoramaC2w` 和
`metersPerUnit` 放在调用方的世界坐标系中，结果中的所有相机都在该坐标系下。任务返回
`operation: pano`。1 积分。
operationId: createSceneFromCustomPano
parameters:
- $ref: '#/components/parameters/RequestId'
- $ref: '#/components/parameters/SourceChannel'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SceneCustomPanoRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SceneCustomPanoForm'
responses:
'200':
description: 场景任务已启动。
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/SceneTask'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/V1Unauthorized'
'402':
$ref: '#/components/responses/PaymentRequired'
'408':
$ref: '#/components/responses/SceneUploadTimeout'
'409':
$ref: '#/components/responses/SceneSessionBusy'
'429':
$ref: '#/components/responses/RateLimited'
'503':
$ref: '#/components/responses/ServiceUnavailable'
components:
parameters:
RequestId:
name: X-Request-Id
in: header
required: false
description: 可选的调用者自定义关联 ID，最长 128 字符。服务会在响应头返回实际使用的值，便于追踪和支持排查。
schema:
type: string
minLength: 1
maxLength: 128
SourceChannel:
name: X-Viggle-Source
in: header
required: false
description: 可选来源标签，最长 128 字符，用于识别 SDK、集成、产品入口或内部工作流。
schema:
type: string
minLength: 1
maxLength: 128
schemas:
SceneCustomPanoRequest:
type: object
additionalProperties: false
description: >-
`POST /v1/scenes/custom-pano` 的请求体。全景图放在调用方世界坐标系中的 `panoramaC2w`
处：模型坐标系中的点 `p` 对应 `R · (metersPerUnit · p) + t`。旋转部分必须正交且不含镜像（容差
`1e-4`），平移分量绝对值的最大值加上 `25 × metersPerUnit` 必须小于 `4000`。
required:
- sessionId
- panoramaUri
- panoramaC2w
properties:
sessionId:
$ref: '#/components/schemas/SceneSessionId'
panoramaUri:
type: string
format: uri
description: 360° 全景图的 URL。
panoramaC2w:
$ref: '#/components/schemas/SceneMatrix'
metersPerUnit:
type: number
minimum: 0.05
default: 1
description: 在应用 `panoramaC2w` 之前作用于模型坐标的缩放系数。
spzOutputUrl:
type: string
format: uri
description: 等同于 `outputUris.spz`。
outputUris:
$ref: '#/components/schemas/SceneOutputUris'
SceneCustomPanoForm:
type: object
additionalProperties: false
description: >-
`POST /v1/scenes/custom-pano` 的 multipart 表单形式，用于直接上传全景图文件。字段与 JSON
请求体相同，每个只能发送一次；`panoramaC2w`、`metersPerUnit` 和 `outputUris` 以文本形式携带其
JSON 值。`panorama` 文件和 `panoramaUri` 必须且只能发送其一。计费与使用 `panoramaUri` 相同。
required:
- sessionId
- panoramaC2w
properties:
sessionId:
$ref: '#/components/schemas/SceneSessionId'
panorama:
type: string
format: binary
description: >-
360° 全景图文件，取代 `panoramaUri`：1 字节到 50 MiB，按文件内容识别为 JPEG、PNG 或 WebP
图片。表单只能携带这一个文件。
panoramaUri:
type: string
format: uri
description: 360° 全景图的 URL；不能与 `panorama` 文件同时使用。
panoramaC2w:
type: string
description: 以 JSON 文本发送的全景图相机到世界矩阵：四行、每行四个数字，最后一行为 `[0, 0, 0, 1]`。
metersPerUnit:
type: string
description: 在应用 `panoramaC2w` 之前作用于模型坐标的缩放系数，以 JSON 文本发送。不小于 `0.05`，默认 `1`。
spzOutputUrl:
type: string
format: uri
description: 等同于 `outputUris.spz`。
outputUris:
type: string
description: '以 JSON 文本发送的 `SceneOutputUris`，例如 `{"spz": "https://..."}`。'
SceneTask:
type: object
additionalProperties: false
description: >-
场景任务（以 `scn_` 开头），所有 `/v1/scenes` 提交接口和 `GET /v1/scenes/{task_id}`
都返回它。任务以 `queued` 开始（有空闲 GPU 时直接为
`processing`），`ready`、`failed`、`cancelled` 为终态。只有 `ready` 的任务保留扣费。任务结束后约
72 小时内可查询。
required:
- id
- sessionId
- operation
- status
- credits
- createdAt
- completedAt
- result
- error
properties:
id:
type: string
description: 任务 ID，格式为 `scn_{runId}.{sessionId}`。
sessionId:
type: string
operation:
type: string
enum:
- pano
- generate
- reconstruct
description: custom-pano 任务也返回 `pano`。
status:
type: string
enum:
- queued
- processing
- ready
- failed
- cancelled
queuePosition:
type: integer
minimum: 0
description: 仅在 `queued` 时返回：排在本任务前面的任务数，轮到它时为 0。
credits:
type: number
minimum: 0
description: 本任务收取的积分：提交时预扣（从文字描述创建场景为 6，其他任务为 1）；未以 `ready` 结束的任务退款后为 0。
createdAt:
type: integer
format: int64
nullable: true
description: 开始时间，Unix 毫秒。
completedAt:
type: integer
format: int64
nullable: true
description: 结束时间，Unix 毫秒；`queued` 或 `processing` 时为 null。
result:
description: 只在 `ready` 时有值。
nullable: true
allOf:
- $ref: '#/components/schemas/SceneResult'
error:
description: >-
只在 `failed` 时有值。`code` 为
`INVALID_REQUEST`（不可重试，模型拒绝了输入，例如引用了其他会话的批次）或
`PROCESSING_FAILED`（可重试）。
nullable: true
allOf:
- $ref: '#/components/schemas/ErrorBody'
SceneSessionId:
type: string
minLength: 1
maxLength: 128
pattern: ^[A-Za-z0-9_-]+$
description: >-
调用方自定的会话 ID，按账户隔离。一个会话对应一个场景及其全部图像批次，同一时间只运行一个任务；已有任务 `processing`
时再提交会返回 `409`，`error.details.running_task_id` 为正在运行的任务。
example: living-room-01
SceneMatrix:
type: array
description: >-
4 × 4 相机到世界（camera-to-world）矩阵，按行写成 4 行、每行 4 个有限数值；最后一行必须为 `[0, 0, 0,
1]`。
minItems: 4
maxItems: 4
items:
type: array
minItems: 4
maxItems: 4
items:
type: number
example:
- - 1
- 0
- 0
- 0
- - 0
- 1
- 0
- 0
- - 0
- 0
- 1
- 0
- - 0
- 0
- 0
- 1
SceneOutputUris:
type: object
additionalProperties: false
description: >-
调用方自己的上传地址，Viggle 完成后用 `PUT` 把对应文件上传过去；值为 null 的项会被忽略。上传到这里的 `.spz`
Viggle 不再保留，结果中的 `spz.url` 即该地址；预览图和全景图上传后 Viggle 仍保留一份，结果中链接指向 Viggle
的副本。每个地址必须是 `http(s)`、不含账号密码、且主机只解析到公网地址。
properties:
spz:
type: string
format: uri
nullable: true
preview:
type: string
format: uri
nullable: true
panorama:
type: string
format: uri
nullable: true
SceneResult:
type: object
required:
- operation
- sessionId
- spz
- preview
- panorama
- outputBatch
- referenceViewCount
- newViewCount
- seconds
properties:
operation:
type: string
enum:
- pano
- generate
- reconstruct
sessionId:
type: string
spz:
description: SPZ 格式的高斯泼溅场景，`pano` 与 `reconstruct` 产出。
nullable: true
allOf:
- $ref: '#/components/schemas/SceneFile'
preview:
description: 预览图，操作产出时才有。
nullable: true
allOf:
- $ref: '#/components/schemas/SceneFile'
panorama:
description: 构建场景所用的全景图，`pano` 产出。
nullable: true
allOf:
- $ref: '#/components/schemas/SceneFile'
outputBatch:
description: 本任务新增的批次；`reconstruct` 为 null。
nullable: true
allOf:
- $ref: '#/components/schemas/SceneOutputBatch'
referenceViewCount:
type: integer
description: 从 `referenceBatchIds` 读取的视图数。
newViewCount:
type: integer
description: 新产出的视图数。
seconds:
type: object
description: 各阶段耗时（秒），仅供参考，键名随操作而变。
additionalProperties:
type: number
ErrorBody:
type: object
additionalProperties: false
required:
- code
- message
- retryable
- request_id
- details
- remediation
properties:
code:
description: 恢复方法
allOf:
- $ref: '#/components/schemas/ErrorCode'
message:
type: string
description: 供人阅读的描述，不要解析其文本做逻辑判断。
retryable:
type: boolean
description: 重试相同请求是否可能成功。
request_id:
type: string
description: 用于关联 Viggle 日志与支持排查。仅当异步工作进程无法恢复原请求 ID 时为 `null`。
details:
type: object
description: 补充结构化信息，可能为空。
additionalProperties: true
remediation:
description: >-
`{action, retry_after_ms}`，表示下一步操作。除非建议定时重试，否则 `retry_after_ms` 为
`null`。
allOf:
- $ref: '#/components/schemas/ErrorRemediation'
ErrorResponse:
type: object
additionalProperties: false
required:
- error
properties:
error:
description: 草稿流程的顶层错误，包含稳定错误码、说明、重试建议、关联 ID 和错误详情。
allOf:
- $ref: '#/components/schemas/ErrorBody'
SceneFile:
type: object
additionalProperties: false
required:
- url
properties:
url:
type: string
format: uri
description: 下载链接。Viggle 签名链接 3 小时内有效，重新查询任务即可获得新链接；`.spz` 上传到调用方地址时即为该地址。
SceneOutputBatch:
type: object
additionalProperties: false
required:
- batchId
- createdAt
- manifest
description: '`pano` 或 `generate` 任务在会话中新增的图像批次。这两个字段上线前完成的任务没有 `kind` 和 `views`。'
properties:
batchId:
type: string
description: 批次 ID，小写 UUID，可传入 `referenceBatchIds`。
createdAt:
type: number
description: 批次创建时间，Unix 毫秒。
manifest:
$ref: '#/components/schemas/SceneFile'
kind:
type: string
enum:
- initial
- generated
views:
type: array
items:
$ref: '#/components/schemas/SceneView'
ErrorCode:
description: 草稿渲染流程的错误码集合。资源操作将相应错误映射为 ResourceError 说明的小写下划线形式。
type: string
enum:
- UNAUTHENTICATED
- INVALID_CREDENTIAL
- FORBIDDEN
- INVALID_REQUEST
- INVALID_CHARACTER
- INVALID_MOTION
- UNSUPPORTED_MEDIA
- CONTENT_POLICY_VIOLATION
- UPLOAD_REQUIRED
- UPLOAD_MISMATCH
- UPLOAD_EXPIRED
- DRAFT_NOT_FOUND
- DRAFT_ALREADY_CONSUMED
- RENDER_NOT_FOUND
- RENDER_NOT_CANCELLABLE
- CHARACTER_NOT_FOUND
- MOTION_NOT_FOUND
- MOTION_NOT_READY
- MOTION_TEMPLATE_NOT_FOUND
- AVATAR_NOT_FOUND
- ANIMATION_NOT_FOUND
- EXTRACTION_UNAVAILABLE
- EXTRACTION_FAILED
- IDEMPOTENCY_KEY_REUSED
- INSUFFICIENT_CREDITS
- RATE_LIMITED
- SERVICE_BUSY
- INTERNAL_ERROR
- NOT_FOUND
- TASK_FAILED
- PROCESSING_FAILED
ErrorRemediation:
type: object
additionalProperties: false
required:
- action
- retry_after_ms
properties:
action:
type: string
description: 建议的下一步操作，供程序或人工读取，例如稍后重试、重新上传或修正输入。
retry_after_ms:
type: integer
description: 建议重试等待的毫秒数；无需定时重试时为 null。
nullable: true
format: int64
minimum: 0
SceneView:
type: object
additionalProperties: false
required:
- index
- url
- c2w
- intrinsic
properties:
index:
type: integer
minimum: 0
description: 在批次中的序号，从 0 开始。
url:
type: string
format: uri
description: 图像的签名下载链接，3 小时内有效。
c2w:
$ref: '#/components/schemas/SceneMatrix'
intrinsic:
type: array
description: 相机内参，与批次清单中记录的一致。
items:
type: number
headers:
RequestId:
description: 用于支持排查和追踪的稳定请求 ID。
schema:
type: string
responses:
BadRequest:
description: 请求失败，详情见错误响应。
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
V1Unauthorized:
description: 请求失败，详情见错误响应。
headers:
WWW-Authenticate:
schema:
type: string
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
PaymentRequired:
description: 请求失败，详情见错误响应。
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
SceneUploadTimeout:
description: multipart 上传未能在读取时限前传完。错误码 `UPLOAD_TIMEOUT`，可重试：请重新上传，或改用 `panoramaUri`。
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
SceneSessionBusy:
description: >-
该会话已有任务在排队或运行，`error.details.running_task_id` 为该任务。错误码
`INVALID_REQUEST`。
headers:
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
RateLimited:
description: 请求失败，详情见错误响应。
headers:
Retry-After:
schema:
type: integer
minimum: 0
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
ServiceUnavailable:
description: 请求失败，详情见错误响应。
headers:
Retry-After:
schema:
type: integer
minimum: 0
X-Request-Id:
$ref: '#/components/headers/RequestId'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API key or OAuth access token
description: 服务端 SDK 使用项目 API 密钥，Remote MCP 使用 OAuth 访问令牌。不要在浏览器代码中暴露项目密钥。
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.