Sign up

API → ML → Generate a CAD model from text

Parameters

Name

Type

Req.

  • output_format

    string
    required
    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)>

  • kcl

    boolean
    optional

  • bodyapplication/json

    object
    optional
    Object Properties

Returns

  • 201 Created

    successful creation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties

    • code

      string
      optional

    • completed_at

      string / ISO-8601
      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

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

    • updated_at

      string / ISO-8601
      optional

    • user_id

      string / UUID
      optional
post
/ai/text-to-cad/{output_format}
$ curl -X POST "https://api.zoo.dev/ai/text-to-cad/{output_format}" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '{
  "prompt": "2TGiaPonr7W8XPvbuGXiMwGk6c"
}'
201 Created
Response
{
  "code": "0T6AARismKYRyU435h4p",
  "completed_at": "2024-11-20T19:29:33.909Z",
  "created_at": "2024-11-20T19:29:33.909Z",
  "error": "smSrrlNNHYqf5kc27r4oyEfWgX5",
  "feedback": "thumbs_down",
  "id": "f9caca5c-02ef-42ed-a83e-82dc4d3daae3",
  "model": "kcl_iteration",
  "model_version": "Lo9RGSlGXkbKKXodR6",
  "output_format": "step",
  "outputs": {},
  "prompt": "mOjr08d6roXpKrDtN",
  "started_at": "2024-11-20T19:29:33.909Z",
  "status": "in_progress",
  "updated_at": "2024-11-20T19:29:33.909Z",
  "user_id": "c2412225-f267-47ec-bc6f-bacb1323b6bb"
}