> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neural4d.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 查询模型

> 通过 UUID 查询已生成的模型。



## OpenAPI

````yaml /openapi.old.zh.json post /api/retrieveModel
openapi: 3.0.3
info:
  title: Neural4D 管理接口
  description: Neural4D 管理接口规范，中文界面下使用本规范展示中文接口说明。
  version: 1.5.4
servers:
  - url: https://alb.neural4d.com:3000
    description: 生产环境
security:
  - bearerAuth: []
tags:
  - name: text-to-3d
    description: 用于通过文本生成 3D 模型的接口。
    x-group: 文本生成 3D
  - name: image-to-3d
    description: 用于通过图片生成 3D 模型的接口。
    x-group: 图片生成 3D
  - name: model-management
    description: 用于查询模型、跟踪任务和转换格式的接口。
    x-group: 模型管理
  - name: media-generation
    description: 用于生成图片、视频以及查询结果的接口。
    x-group: 图片与视频生成
  - name: account-and-validation
    description: 用于校验输入图片和查询点数余额的接口。
    x-group: 账户与校验
paths:
  /api/retrieveModel:
    post:
      tags:
        - model-management
      summary: 查询模型
      description: 通过 UUID 查询已生成的模型。
      operationId: retrieveModel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UuidRequest'
            examples:
              default:
                value:
                  uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479
      responses:
        '200':
          description: 模型查询结果
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveModelResponse'
              examples:
                completed:
                  value:
                    codeStatus: 0
                    message: Generate model success
                    modelUrl: >-
                      https://cos.zmkj.com/afsafr24.glb?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa
                    imageUrl: >-
                      https://cos.zmkj.com/afsafr24.jpg?AWSAccessKeyId=AKIDodI2mK61Xsfasfsfsa
                    prompts: a cute bird
                    createdAt: '2024-11-07T05:59:40.000Z'
                    sourcePage: createModel
components:
  schemas:
    UuidRequest:
      type: object
      required:
        - uuid
      properties:
        uuid:
          type: string
          description: 由创建接口返回的任务或模型唯一标识。
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
    RetrieveModelResponse:
      type: object
      required:
        - codeStatus
        - message
      properties:
        codeStatus:
          type: integer
          enum:
            - -3
            - -2
            - -1
            - 0
            - 1
          description: >-
            结果状态。`0` 表示已完成，`1` 表示生成中，`-1` 表示 token 无效或已过期，`-2` 表示 UUID 不存在，`-3`
            表示生成失败。
        message:
          type: string
          description: 查询状态消息。
        modelUrl:
          type: string
          format: uri
          nullable: true
          description: 生成完成后可用的模型下载链接。
        imageUrl:
          type: string
          format: uri
          nullable: true
          description: 生成完成后可用的模型预览图链接。
        prompts:
          type: string
          nullable: true
          description: 与该模型关联的提示词内容。
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: 模型创建时间。
        sourcePage:
          type: string
          nullable: true
          description: 服务返回的来源页面标记。
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 使用 Neural4D 网站提供的 Bearer token。
      x-default: YOUR_TOKEN

````