Archive format to return. Defaults to `tar`.

format

Archive formats supported by project download endpoints.

Download a project using a share link.

Zookeeper

Zookeeper: The Conversational CAD Agent For Parametric Modeling

Automation

Automating Your Workflow

File Formats

A Practical Overview of CAD File Formats

KCL: A Programming Language for Parametric CAD

Geometry Engine

Zoo CAD Engine Overview

Overview

Getting Started

Parametric Modeling

Assemblies

3D Design

Modes

Queue and Steer

Zoodle

ML / AI

Simulation

GD&T Annotations (MBD)

Documentation

Import

Export

Version Control

Default Project Folder

Aquarium

Data Management

Technical Support

Zoo Design Studio Stream

System Requirements

Project Browser

Modeling Area

New Window

Feature Tree

Body Pane

Code Editor

File Explorer

Variables Pane

Command Bar

AI Chat

Top Bar

Status Bar

Settings

Appearance

Workspace

Features

Aquarium CAD Gallery

Zoo Design Studio

Authentication

Errors

Modeling

API Calls

API Tokens

Apps

Executor

File

Oauth2

Orgs

Payments

Projects

Service Accounts

Shortlinks

Store

Unit

Users

delete

list

alias

status

api-call

login

logout

auth

completion

config

drake

center-of-mass

convert

density

mass

snapshot

surface-area

volume

file

markdown

generate

analyze

bounding-box

export

lint

view

text-to-cad

open

dataset

download

publish

upload

project

start-session

update

edit

user

version

Convert an OBJ file to STEP

Convert an OBJ file to STL

Get file metadata (mass, volume)

JavaScript Beginner Tutorial

Python Beginner Tutorial

Text-to-CAD Tutorial

Using The Modeling API

Tutorials

Developer Tools

Intro to KCL

KCL Language Reference

KCL Standard Library

Arrangement

Assembly

Client

Cookie

Drawing

Endpoint

Host

Memory

Model

One-off

Part

Scale

Scene Editing

Sketching

Storage

View

Wireframe

Glossary

SAML Configuration Reference

Enterprise

Resources

The ZooCorp account provider (aka https://auth.corp.zoo.dev).

Test provider for integration tests (only available during testing).

The response from the `AddHoleFromOffset` command.

If the offset path splits into multiple paths, this will contain the UUIDs of the new paths. If the offset path remains as a single path, this will be empty, and the resulting ID of the (single) new path will be the ID of the `AddHoleFromOffset` command.

The email address of the user to add to the org.

An ISO-3166 alpha-2 country code. Always uppercase.

The country component. This is a two-letter ISO country code.

The time and date the address was created.

DateTime

The time and date the address was last updated.

The user ID that this address belongs to.

Edge info struct (useful for maintaining mappings between edges and faces and adjacent/opposite edges).

The size of the angle, measured in the chosen unit.

Parameters for defining an MBD Basic Dimension Annotation state which is measured between two positions in 3D

The scale of the dimension arrows. Defaults to 1.

Parameters for defining an MBD basic dimension

Basic dimension parameters (symbol and tolerance)

The point size of the fonts used to generate the annotation label.  Very large values can negatively affect performance.

An edge can be referenced by its uuid or by the faces that uniquely define it.

Edge reference to use to measure the dimension from If both `from_entity_id` and `from_edge_reference` are provided, `from_edge_reference` takes precedence.

Normalized position within the entity to position the dimension from

2D Position offset of the annotation within the plane.

Orientation plane.  The annotation will lie in this plane which is positioned about the leader position as its origin.

Number of decimal places to use when displaying tolerance and dimension values

Edge reference to use to measure the dimension from If both `to_entity_id` and `to_edge_reference` are provided, `to_edge_reference` takes precedence.

Normalized position within the entity to position the dimension to

Parameters for defining an MBD Feature Control Annotation state

Parameters for defining an MBD Geometric control frame

Set if this annotation is defining a datum

Edge reference to use to place the annotation leader from If both `entity_id` and `edge_reference` are provided, `edge_reference` takes precedence.

Entity to place the annotation leader from

Normalized position within the entity to position the annotation leader from

The scale of the leader (dot or arrow). Defaults to 1.

Prefix text which will appear before the basic dimension

Suffix text which will appear after the basic dimension

Parameters for defining an MBD Feature Tag Annotation state

Whether or not to display the key on the annotation label

How to style the end of the annotation line.

How to style the start of the annotation line.

The explicitly defined dimension.  Only required if the measurement is not automatically calculated.

Type of symbol to use for this dimension (if required)

Diameter symbol (if required) whether the geometric control requires a cylindrical or diameter tolerance

Geometric symbol, the type of geometric control specified

Tolerance value - the total tolerance of the geometric control.  The unit is based on the drawing standard.

Set as an MBD measured basic dimension annotation

How to style the start and end of the line

Length Units to use for this individual annotation.  If not provided, the units set by SetSceneUnits will be used.

2D annotation type (screen or planar space)

An announcement broadcast to all clients.

Response containing active announcements.

The async API call was uploaded to be converted.

An API call with the price.

This is a join of the `ApiCall` and `ApiCallPrice` tables.

The date and time the API call completed billing.

The date and time the API call was created.

int64

String

The Request Method (VERB)

This type also contains constants for a number of common HTTP methods such as GET, POST, etc.

Currently includes 8 variants representing the 8 methods defined in [RFC 7230](https://tools.ietf.org/html/rfc7231#section-4.1), plus PATCH, and an Extension variant for all extensions.

The HTTP method requested by the API call.

The number of minutes the API call was billed for.

Path parameters

/{key}

Query string parameters

?format=

Response

NaN Unknown

Examples

Download a project using a share linkhidden