API → MLGet a text-to-CAD response

Parameters

Name

Type

Req.

  • id

    string / UUID
    required

Returns

  • 200 OK

    successful operation

    Name

    Type

    Req.

    body

    oneOf
    optional
    One of

    • text_to_cad

      object
      optional
      Object Properties

      • code

        string
        optional

      • completed_at

        string / ISO-8601
        optional

      • conversation_id

        string / UUID
        optional

      • created_at

        string / ISO-8601
        optional

      • error

        string
        optional

      • feedback

        string
        optional
        Possible values
        • thumbs_up:  Thumbs up.
        • thumbs_down:  Thumbs down.
        • accepted:  Accepted.
        • rejected:  Rejected.

      • id

        string / UUID
        optional

      • kcl_version

        string
        optional

      • model

        string
        optional
        Possible values
        • cad:  CAD.
        • kcl:  KCL.
        • kcl_iteration:  KCL iteration.

      • model_version

        string
        optional

      • output_format

        string
        optional
        Possible values
        • fbx:  Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
        • glb:  Binary glTF 2.0. This is a single binary with .glb extension. This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
        • gltf:  glTF 2.0. Embedded glTF 2.0 (pretty printed). Single JSON file with .gltf extension binary data encoded as base64 data URIs. The JSON contents are pretty printed. It is human readable, single file, and you can view the diff easily in a git commit.
        • obj:  The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
        • ply:  The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
        • step:  The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
        • stl:  The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>

      • outputs

        object
        optional

      • prompt

        string
        optional

      • started_at

        string / ISO-8601
        optional

      • status

        string
        optional
        Possible values
        • queued:  The async API call is queued.
        • uploaded:  The async API call was uploaded to be converted.
        • in_progress:  The async API call is in progress.
        • completed:  The async API call has completed.
        • failed:  The async API call has failed.

      • type

        string
        optional
        Possible values
        • text_to_cad

      • updated_at

        string / ISO-8601
        optional

      • user_id

        string / UUID
        optional

    • text_to_cad_iteration

      object
      optional
      Object Properties

      • code

        string
        optional

      • completed_at

        string / ISO-8601
        optional

      • conversation_id

        string / UUID
        optional

      • created_at

        string / ISO-8601
        optional

      • error

        string
        optional

      • feedback

        string
        optional
        Possible values
        • thumbs_up:  Thumbs up.
        • thumbs_down:  Thumbs down.
        • accepted:  Accepted.
        • rejected:  Rejected.

      • id

        string / UUID
        optional

      • model

        string
        optional
        Possible values
        • cad:  CAD.
        • kcl:  KCL.
        • kcl_iteration:  KCL iteration.

      • model_version

        string
        optional

      • original_source_code

        string
        optional

      • prompt

        string
        optional

      • source_ranges

        array
        optional
        Array of

        • file

          string
          optional

        • prompt

          string
          optional

        • range

          object
          optional
          Object Properties

          • end

            object
            optional
            Object Properties

          • start

            object
            optional
            Object Properties

      • started_at

        string / ISO-8601
        optional

      • status

        string
        optional
        Possible values
        • queued:  The async API call is queued.
        • uploaded:  The async API call was uploaded to be converted.
        • in_progress:  The async API call is in progress.
        • completed:  The async API call has completed.
        • failed:  The async API call has failed.

      • type

        string
        optional
        Possible values
        • text_to_cad_iteration

      • updated_at

        string / ISO-8601
        optional

      • user_id

        string / UUID
        optional

    • text_to_cad_multi_file_iteration

      object
      optional
      Object Properties

      • completed_at

        string / ISO-8601
        optional

      • conversation_id

        string / UUID
        optional

      • created_at

        string / ISO-8601
        optional

      • error

        string
        optional

      • feedback

        string
        optional
        Possible values
        • thumbs_up:  Thumbs up.
        • thumbs_down:  Thumbs down.
        • accepted:  Accepted.
        • rejected:  Rejected.

      • id

        string / UUID
        optional

      • kcl_version

        string
        optional

      • model

        string
        optional
        Possible values
        • cad:  CAD.
        • kcl:  KCL.
        • kcl_iteration:  KCL iteration.

      • model_version

        string
        optional

      • outputs

        object
        optional

      • project_name

        string
        optional

      • prompt

        string
        optional

      • source_ranges

        array
        optional
        Array of

        • file

          string
          optional

        • prompt

          string
          optional

        • range

          object
          optional
          Object Properties

          • end

            object
            optional
            Object Properties

          • start

            object
            optional
            Object Properties

      • started_at

        string / ISO-8601
        optional

      • status

        string
        optional
        Possible values
        • queued:  The async API call is queued.
        • uploaded:  The async API call was uploaded to be converted.
        • in_progress:  The async API call is in progress.
        • completed:  The async API call has completed.
        • failed:  The async API call has failed.

      • type

        string
        optional
        Possible values
        • text_to_cad_multi_file_iteration

      • updated_at

        string / ISO-8601
        optional

      • user_id

        string / UUID
        optional
get
/user/text-to-cad/{id}
$ curl "https://api.zoo.dev/user/text-to-cad/{id}" \
	--header "Authorization: Bearer $TOKEN"
200 OK
Response
{}