> ## 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.

# 获取角色

> 获取单个角色的状态和能力。

创建角色后轮询本接口。仅当 `status` 为 `ready` 且 `capabilities` 包含 `video_render` 时，才可将角色用于渲染。

## 请求参数

| 参数             | 类型     |  必填 | 说明                                                                                        |
| -------------- | ------ | :-: | ----------------------------------------------------------------------------------------- |
| `character_id` | string |  是  | 创建或列出角色时返回的完整公开 ID，例如 `char_550e8400-e29b-41d4-a716-446655440000`。使用同一 ID 轮询，直到所需输出就绪或失败。 |

## 响应参数

返回 `200 OK`，字段见[创建角色](/zh/v1/api-reference/characters/create)，包括 `type` 和 `vsplat`。失败的角色也返回 `200`，请读取 `status` 判断失败。本接口顶层 `error` 始终为 `null`；对于 `vsplat`/`all` 角色，提取错误详情请检查 `vsplat.error`。

## 示例

<CodeGroup>
  ```go Go theme={null}
  req, _ := http.NewRequest("GET", "https://apis.viggle.ai/v1/characters/"+characterID, nil); req.Header.Set("Authorization", "Bearer "+apiKey); resp, err := http.DefaultClient.Do(req)
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(`https://apis.viggle.ai/v1/characters/${characterId}`, {headers:{Authorization:`Bearer ${process.env.VIGGLE_API_KEY}`}});
  ```

  ```python Python theme={null}
  response = requests.get(f"https://apis.viggle.ai/v1/characters/{character_id}", headers={"Authorization": f"Bearer {os.environ['VIGGLE_API_KEY']}"})
  ```

  ```bash cURL theme={null}
  curl "https://apis.viggle.ai/v1/characters/$CHARACTER_ID" -H "Authorization: Bearer $VIGGLE_API_KEY"
  ```
</CodeGroup>

## 下一步

`vsplat`/`all` 角色的 `vsplat.status` 为 `ready` 后，调用[导出 3D 角色](/zh/v1/api-reference/characters/export)获取下载链接。


## OpenAPI

````yaml zh/openapi.yaml GET /v1/characters/{character_id}
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_）结果。
paths:
  /v1/characters/{character_id}:
    parameters:
      - $ref: '#/components/parameters/CharacterId'
      - $ref: '#/components/parameters/RequestId'
      - $ref: '#/components/parameters/SourceChannel'
    get:
      tags:
        - Characters
      summary: 获取角色
      operationId: v1GetCharacter
      responses:
        '200':
          description: 请求成功。
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
        '400':
          $ref: '#/components/responses/ResourceBadRequest'
        '401':
          $ref: '#/components/responses/ResourceUnauthorized'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '500':
          $ref: '#/components/responses/ResourceInternalServerError'
        '503':
          $ref: '#/components/responses/ResourceServiceUnavailable'
components:
  parameters:
    CharacterId:
      name: character_id
      in: path
      required: true
      description: 创建或列出角色时返回的公开 ID，通常以 char_ 开头，必须属于当前调用者。
      schema:
        type: string
        minLength: 1
      example: char_2f1c4b8e9d7a4f2ab6c3d5e7f9a1b3c5
    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
  headers:
    RequestId:
      description: 用于支持排查和追踪的稳定请求 ID。
      schema:
        type: string
  schemas:
    Asset:
      description: >-
        角色和动作共用的资源结构。列表中的 progress 为 null，顶层 error 当前始终为 null，失败请检查 status。角色
        type 为 render、vsplat、all，动作为 render、glb、all，旧资源默认报告 render。vsplat/glb
        仅包含提取状态，下载链接通过角色或动作的 /export 获取。未请求提取时对应字段为 null。all 需等 2D 与 3D 均就绪才为
        ready；任一失败则顶层 failed，子对象状态可用于定位。
      type: object
      additionalProperties: false
      required:
        - id
        - status
        - name
        - progress
        - capabilities
        - created_at
        - completed_at
        - error
        - type
        - vsplat
        - glb
      properties:
        id:
          type: string
          description: 素材公开 ID。角色通常以 char_ 开头，动作通常以 mot_ 开头。
          minLength: 1
        status:
          description: 素材整体生命周期。所需能力就绪后才能用于渲染或导出。
          allOf:
            - $ref: '#/components/schemas/ResourceStatus'
        name:
          type: string
          description: 创建时提供或导入时生成的显示名称；不支持名称的流程可能返回空字符串。
        progress:
          type: integer
          description: 详情中尽可能提供 0–100 的处理百分比，列表中或不可用时为 null。
          nullable: true
          minimum: 0
          maximum: 100
        capabilities:
          description: 素材具备的能力。就绪且可渲染时包含 video_render。
          type: array
          items:
            type: string
        created_at:
          description: 带 UTC 偏移的 ISO 8601 时间，例如 2026-07-31T09:15:22+00:00。
          type: string
          nullable: true
        completed_at:
          type: string
          description: 所有请求处理进入终态时的 ISO 8601 时间，带 UTC 偏移；处理中为 null。
          nullable: true
        error:
          type: object
          description: 保留的顶层错误详情，目前始终为 null。通过 status 判断失败，并在适用时检查提取子对象。
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ResourceError'
        type:
          type: string
          description: 创建时请求的输出。render 为可渲染的 2D 素材，vsplat/glb 为 3D 输出，all 同时请求两种支持的输出。
          enum:
            - render
            - vsplat
            - glb
            - all
          default: render
        vsplat:
          description: >-
            角色 vsplat 提取状态。动作及 type=render 的角色为 null。这里只返回状态，不回显 model_precision
            等创建参数。
          nullable: true
          type: object
          additionalProperties: false
          required:
            - status
            - error
          properties:
            status:
              description: 角色 vsplat 提取自身的生命周期，独立于顶层素材状态。
              allOf:
                - $ref: '#/components/schemas/ResourceStatus'
            error:
              type: object
              description: vsplat 状态为 failed 时的结构化错误，否则为 null。
              nullable: true
              allOf:
                - $ref: '#/components/schemas/ResourceError'
        glb:
          description: 动作 3D 动画提取或生成状态。角色及 type=render 的动作为 null。
          nullable: true
          type: object
          additionalProperties: false
          required:
            - status
            - skeletons
            - error
          properties:
            status:
              description: 动作 3D 提取或生成自身的生命周期，独立于顶层素材状态。
              allOf:
                - $ref: '#/components/schemas/ResourceStatus'
            skeletons:
              description: >-
                可通过 GET /v1/motions/{motion_id}/export?download_type=
                导出的骨架。就绪前为空；两种骨架预先一起生成，就绪后为 [mixamo, metahuman]。
              type: array
              items:
                type: string
                enum:
                  - mixamo
                  - metahuman
            error:
              type: object
              description: 3D 动画状态为 failed 时的结构化错误，否则为 null。
              nullable: true
              allOf:
                - $ref: '#/components/schemas/ResourceError'
    ResourceStatus:
      description: 异步资源共用的公开生命周期，枚举值与 RenderStatus 相同。
      type: string
      enum:
        - queued
        - processing
        - ready
        - failed
        - cancelled
    ResourceError:
      description: >-
        异步资源附带的错误。code 为稳定的小写下划线字符串，故意不限制为枚举，工作进程可能新增值；无公开映射时使用
        processing_failed。已发布值包括
        worker_stopped、motion_model_mismatch、image_required、motion_video_required、unsupported_video_format、video_too_long、video_too_large、video_resolution_too_high、video_unreadable、invalid_background_mode、video_dimensions_must_be_even、result_expired、video_inaccessible、no_humans_detected、all_workers_busy、task_failed、unexpected_error、processing_failed。
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: 稳定的小写下划线异步错误码。集合可扩展，客户端应容忍新值。
          minLength: 1
        message:
          type: string
          description: 供人阅读的异步处理失败说明。
        request_id:
          type: string
          description: 工作进程或原始请求的关联 ID，不可用时为 null。
          nullable: true
    ResourceErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          description: 同步资源操作失败的顶层错误对象。
          allOf:
            - $ref: '#/components/schemas/ResourceHttpError'
    ResourceHttpError:
      description: >-
        同步资源请求的错误封装。错误码由 API 服务中的固定映射生成，无公开映射的失败使用 processing_failed。资源的异步 error
        对象采用 ResourceError 中更广泛、可扩展的错误码集合。
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: 同步资源请求的固定小写下划线错误码，用于程序化处理。
          enum:
            - authentication_required
            - invalid_api_key
            - insufficient_credits
            - invalid_request
            - motion_not_ready
            - character_not_found
            - motion_not_found
            - not_found
            - id_already_exists
            - rate_limited
            - service_unavailable
            - task_failed
            - internal_error
            - processing_failed
        message:
          type: string
          description: 供人阅读的同步请求失败说明。
        request_id:
          description: 同步失败时始终为 null，请通过 X-Request-Id 响应头关联请求。
          type: string
          nullable: true
  responses:
    ResourceBadRequest:
      description: 请求失败，详情见错误响应。
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceErrorResponse'
    ResourceUnauthorized:
      description: 请求失败，详情见错误响应。
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceErrorResponse'
    ResourceNotFound:
      description: 请求失败，详情见错误响应。
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceErrorResponse'
    ResourceInternalServerError:
      description: 请求失败，详情见错误响应。
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceErrorResponse'
    ResourceServiceUnavailable:
      description: 请求失败，详情见错误响应。
      headers:
        Retry-After:
          schema:
            type: integer
            minimum: 0
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key or OAuth access token
      description: 服务端 SDK 使用项目 API 密钥，Remote MCP 使用 OAuth 访问令牌。不要在浏览器代码中暴露项目密钥。

````