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

# Retrieve model

> Retrieve a generated model by UUID.



## OpenAPI

````yaml /openapi.old.json post /api/retrieveModel
openapi: 3.0.3
info:
  title: Neural4D Management API
  description: Management endpoints for Neural4D, including request and response examples.
  version: 1.5.4
servers:
  - url: https://alb.neural4d.com:3000
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: text-to-3d
    description: Create 3D models from text prompts.
    x-group: Text to 3D
  - name: image-to-3d
    description: Create 3D models from uploaded images.
    x-group: Image to 3D
  - name: model-management
    description: Retrieve finished models, track jobs, and convert model formats.
    x-group: Model management
  - name: media-generation
    description: Generate pictures and videos and query their results.
    x-group: Picture and video generation
  - name: account-and-validation
    description: Check portrait inputs and query remaining points.
    x-group: Account and validation
paths:
  /api/retrieveModel:
    post:
      tags:
        - model-management
      summary: Retrieve model
      description: Retrieve a generated model by 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: Model retrieval result
          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: >-
            Unique job or model identifier returned by a previous create
            endpoint.
          example: f47ac10b-58cc-4372-a567-0e02b2c3d479
    RetrieveModelResponse:
      type: object
      required:
        - codeStatus
        - message
      properties:
        codeStatus:
          type: integer
          enum:
            - -3
            - -2
            - -1
            - 0
            - 1
          description: >-
            Result status. `0` means completed, `1` means generating, `-1` means
            the token is invalid or expired, `-2` means the UUID does not exist,
            and `-3` means generation failed.
        message:
          type: string
          description: Retrieval status message.
        modelUrl:
          type: string
          format: uri
          nullable: true
          description: Download URL for the generated model when available.
        imageUrl:
          type: string
          format: uri
          nullable: true
          description: Preview image URL for the generated model when available.
        prompts:
          type: string
          nullable: true
          description: Prompt content associated with the generated model.
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: Model creation timestamp.
        sourcePage:
          type: string
          nullable: true
          description: Source page marker returned by the service.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use the bearer token provided through the Neural4D website.
      x-default: YOUR_TOKEN

````