PropertyVisualization

  • Base schema for all async processing jobs

    • createdAt
      Type: string Format: date-time

      When the job was created

    • endImageUrl
      Type: string | null Format: uri

      URL of the end image (for VIDEO type)

    • errorMessage
      Type: string | null

      Set when status is FAILED. For 2D-to-3D jobs, NOT_CONVERTIBLE: <code> means the submitted photos cannot produce one product (codes: MULTIPLE_PRODUCTS, NO_PRODUCT_DETECTED, INCOMPLETE_PRODUCT, ALL_INSTANCES_OCCLUDED, OBJECT_TOO_SMALL, TOO_FINE_FOR_RESOLUTION, MATTE_UNRELIABLE) — resubmitting the same photos gives the same verdict; change the photos. GENERATION_REJECTED: <reason> means the reconstruction provider refused the request; GENERATION_FAILED: <reason> (ultra only, which is generated once) means a transient provider failure ended the job - both are final for that job; submit again to try again. Any other message is a processing failure that was retried automatically.

    • id
      Type: string Format: uuid

      Unique identifier for the job

    • inputImageUrls
      Type: array string[] Format: uri

      URLs of the input images

    • outputUrls
      Type: array string[] Format: uri

      URLs of the output assets

    • preset
      Type: string | null

      Camera preset (for IMAGE type)

    • startImageUrl
      Type: string | null Format: uri

      URL of the start image (for VIDEO type)

    • status
      Type: string · JobStatusenum

      Status of an async processing job

      values
      • PENDING
      • PROCESSING
      • COMPLETED
      • FAILED
    • subType
      Type: string | null enum

      Sub-type of the visualization (e.g. camera-view, clean-room, restyle, video)

      values
      • camera-view
      • clean-room
      • restyle
      • video
    • type
      Type: string enum

      Type of property visualization

      values
      • IMAGE
      • VIDEO
    • updatedAt
      Type: string Format: date-time

      When the job was last updated