This endpoint requires authentication by a Zoo employee.

DateTime

The date and time the ML prompt was created.

The output file. In the case of TextToCad this is a link to a file in a GCP bucket.

The name of the project, if any. This allows us to group prompts together that come from the same project and user.

The date and time the ML prompt was last updated.

The user ID of the user who created the ML prompt.

Access-Control-Allow-Headers header. This is a comma-separated list of headers.

ID for this request. We return it so that users can report this to us and help us debug their problems.

Get a ML prompt.

Geometry Engine

Zoo CAD Engine Overview

KCL: A Programming Language for Parametric CAD

File Formats

A Practical Overview of CAD File Formats

Text-to-CAD

Text-to-CAD: Generating Editable, Parametric B-Rep CAD Models from Natural Language

Automation

Automating Your Workflow

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.

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.

How to style the end of the annotation line.

How to style the start of the annotation line.

How to style the start and end of the line

2D annotation type (screen or planar space)

A response for a query on the API call table that is grouped by something.

The email of the user that requested the API call.

The user ID of the user that requested the API call.

The origin of the API call. This is parsed from the `Origin` header.

The IP address of the user making the API call.

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.

The organization ID of the API call if it is billable through an organization.

double

The request query params sent by the API call.

The response body returned by the API call. We do not store this information if it is above a certain size.

The date and time the API call started billing.

The status code returned by the API call.

int32

The Stripe invoice item ID of the API call if it is billable.

The date and time the API call was last updated.

The ID of the user that made the API call.

token used to fetch the next page of results (if any)

The type of error sent by the KittyCAD API.

An API token.

These are used to authenticate users with Bearer authentication.

The date and time the API token was created.

If the token is valid. We never delete API tokens, but we can mark them as invalid. We save them for ever to preserve the history of the API token.

An auth token. A uuid with a prefix of api-

The date and time the API token was last updated.

The ID of the user that owns the API token.

Information about a third party app client.

The number of times we've attempted to process this job.

The time and date the async API call was completed.

The time and date the async API call was created.

The unique identifier of the async API call.

This is the same as the API call ID.

The JSON input for the API call. These are determined by the endpoint that is run.

The JSON output for the API call. These are determined by the endpoint that is run.

The time and date the async API call was started.

The time and date the async API call was last updated.

The user ID of the user who created the async API call.

The worker node that is performing or performed the async API call.

The time and date the API call was completed.

The time and date the API call was created.

The unique identifier of the API call.

This is the same as the API call ID.

The output format of the file conversion.

The output format options of the file conversion.

The converted files (if multiple file conversion), if completed, base64 encoded. The key of the map is the path of the output file.

The source format of the file conversion.

The source format options of the file conversion.

The time and date the API call was started.

The time and date the API call was last updated.

The user ID of the user who created the API call.

The material density as denoted by the user.

The material mass as denoted by the user.

The code for the model. This is optional but will be required in the future once we are at v1.

The output of the model in the given file format the user requested, base64 encoded. The key of the map is the path of the output file.

The original source code for the model, previous to the changes.

The prompt for the overall changes. This is optional if you only want changes on specific source ranges.

The source ranges the user suggested to change.

The version of kcl to use. If empty, the latest version will be used.

The output files. Returns a map of the file name to the file contents. The file contents are not encoded since kcl files are not binary.

The project name. This is used to tie the prompt to a project. Which helps us make our models better over time.

The prompt for the overall changes. This is optional if you only want changes on specific source ranges. This will apply to all the files.

The authentication callback from the OAuth 2.0 client. This is typically posted to the redirect URL as query params after authenticating.

For Apple only, a JSON web token containing the user’s identity information.

The state that we had passed in through the user consent URL.

For Apple only, a JSON string containing the data requested in the scope property. The returned data is in the following format: `{ "name": { "firstName": string, "lastName": string }, "email": string }`

Co-ordinate axis specifier.

See [cglearn.eu] for background reading.

[cglearn.eu]: https://cglearn.eu/pub/computer-graphics/introduction-to-geometry#material-coordinate-systems-1

Specifies the sign of a co-ordinate axis.

Specifies which direction the axis is pointing.

Response sent when a request did not succeed.

Errors that occurred during the modeling command.

Websocket responses can either be successful or unsuccessful. Slightly different schemas in either case.

The user is missing a payment method and has exceeded their free API call credits for the month.

The response from the 'BooleanIntersection'.

If the operation produced just one solid, then its ID will be the ID of the modeling command request. But if any extra solids are produced, then their IDs will be included here.

The response from the `CameraDragEnd` command.

Camera rotate (spherical camera revolve/orbit)

Camera rotate (trackball with 3 degrees of freedom)

Camera zoom (increase or decrease distance to reference point center)

The response from the `CameraDragMove` command. Note this is an "unreliable" channel message, so this data may need more data like a "sequence"

The response from the `CameraDragStart` endpoint.

A type of camera movement applied after certain camera operations

Adjusts the camera position during the camera operation

Camera settings including position, center, fov etc

Camera's look-at center (center-pos gives viewing vector)

Camera's field-of-view angle (if ortho is false)

The Camera's orientation (in the form of a quaternion)

Whether or not the camera is in ortho mode

The camera's ortho scale (derived from viewing distance if ortho is true)

Card brand.

Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.

Checks on Card address and CVC if provided.

Two-letter ISO code representing the country of the card.

Two-digit number representing the card's expiration month.

Four-digit number representing the card's expiration year.

Uniquely identifies this particular card number.

Card funding type.

Can be `credit`, `debit`, `prepaid`, or `unknown`.

ClientMetrics contains information regarding the state of the peer.

The height of the inbound video stream in pixels.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-frameheight

The width of the inbound video stream in pixels.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-framewidth

Counter of the number of WebRTC frames that the client has decoded from the inbound video stream.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

Counter of the number of WebRTC frames the client has dropped from the inbound video stream.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-framesdropped

Current number of frames being rendered in the last second. A good target is 60 frames per second, but it can fluctuate depending on network conditions.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

Counter of the number of WebRTC frames that the client has received from the inbound video stream.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

Number of times the inbound video playback has frozen. This is usually due to network conditions.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount

Amount of "jitter" in the inbound video stream. Network latency is the time it takes a packet to traverse the network. The amount that the latency varies is the jitter. Video latency is the time it takes to render a frame sent by the server (including network latency). A low jitter means the video latency can be reduced without impacting smooth playback. High jitter means clients will increase video latency to ensure smooth playback.

https://www.w3.org/TR/webrtc-stats/#dom-rtcreceivedrtpstreamstats-jitter

Number of "key frames" decoded in the inbound h.264 stream. A key frame is an expensive (bandwidth-wise) "full image" of the video frame. Data after the keyframe become -- effectively -- "diff" operations on that key frame. The Engine will only send a keyframe if required, which is an indication that some of the "diffs" have been lost, usually an indication of poor network conditions. We like this metric to understand times when the connection has had to recover.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-keyframesdecoded

Amount of packets lost in the inbound video stream.

https://www.w3.org/TR/webrtc-stats/#dom-rtcreceivedrtpstreamstats-packetslost

Count of the total number of video pauses experienced by this receiver.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-pausecount

Count the total number of Picture Loss Indication (PLI) packets.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-plicount

Total duration of pauses in seconds.

This is the "ping" between the client and the STUN server. Not to be confused with the E2E RTT documented [here](https://www.w3.org/TR/webrtc-stats/#dom-rtcremoteinboundrtpstreamstats-roundtriptime)

https://www.w3.org/TR/webrtc-stats/#dom-rtcicecandidatepairstats-currentroundtriptime

Number of seconds of frozen video the user has been subjected to.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-totalfreezesduration

Count of the total number of video pauses experienced by this receiver.

https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-totalpausesduration

The response from the `ClosePath` command.

The UUID of the lone face of the resulting solid2D.

The language code is written in.

<details><summary>JSON schema</summary>

```json { "description": "The language code is written in.", "oneOf": [ { "description": "The `go` programming language.", "type": "string", "enum": [ "go" ] }, { "description": "The `python` programming language.", "type": "string", "enum": [ "python" ] }, { "description": "The `node` programming language.", "type": "string", "enum": [ "node" ] } ] } ``` </details>

Code option for running and verifying kcl.

<details><summary>JSON schema</summary>

```json { "title": "CodeOption", "description": "Code option for running and verifying kcl.", "type": "string", "enum": [ "parse", "execute", "cleanup", "mock_execute" ] } ``` </details>

Output of the code being executed.

<details><summary>JSON schema</summary>

```json { "description": "Output of the code being executed.", "type": "object", "properties": { "output_files": { "description": "The contents of the files requested if they were passed.", "type": "array", "items": { "$ref": "#/components/schemas/OutputFile" } }, "stderr": { "description": "The stderr of the code.", "default": "", "type": "string" }, "stdout": { "description": "The stdout of the code.", "default": "", "type": "string" } } } ``` </details>

The contents of the files requested if they were passed.

Output file contents.

<details><summary>JSON schema</summary>

```json { "description": "Output file contents.", "type": "object", "properties": { "contents": { "description": "The contents of the file. This is base64 encoded so we can ensure it is UTF-8 for JSON.", "type": "string" }, "name": { "description": "The name of the file.", "default": "", "type": "string" } } } ``` </details>

Struct to contain the edge information of a wall of an extrude/rotate/loft/sweep.

Every edge that shared one common vertex with the original edge.

The opposite edge has no common vertices with the original edge. A wall may not have an opposite edge (i.e. a revolve that touches the axis of rotation).

Container that holds a translate, rotate and scale. Defaults to no change, everything stays the same (i.e. the identity function).

How a property of an object should be transformed.

Rotate component of the transform. The rotation is specified as an axis and an angle (xyz are the components of the axis, w is the angle in degrees).

Rotate component of the transform. The rotation is specified as a roll, pitch, yaw.

Describes the file to convert (src) and what it should be converted into (output).

Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.

Name of the coupon displayed to customers on, for instance invoices, or receipts.

By default the `id` is shown if `name` is not set.

Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.

For example, a coupon with percent_off of 50 will make a %s100 invoice %s50 instead.

The password for the shortlink, if you want to restrict access to it. This can only be set if your subscription allows for it. Otherwise, it will return an error. When you access the link it will be required to enter this password through basic auth. The username will be `{anything}` and the password will be the password you set here.

If the shortlink should be restricted to the user's organization to view. This only applies to org shortlinks. If you are creating a user shortlink and you are not a member of a team or enterprise and you try to set this to true, it will fail.

The key for this url. This is what you use to update or delete the specific shortlink.

Supported set of sort modes for scanning by created_at only.

Currently, we only support scanning in ascending order.

Sort in increasing order of "created_at".

Sort in decreasing order of "created_at".

The data for subscribing a user to the newsletter.

Currency is the list of supported currencies. Always lowercase.

This comes from the Stripe API docs: For more details see <https://support.stripe.com/questions/which-currencies-does-stripe-support>.

The response from the `CurveGetControlPoints` command.

The response from the `CurveGetType` command.

The response from the `CurveSetConstraint` endpoint.

The resource representing a payment "Customer".

Current balance, if any, being stored on the customer in the payments service.

If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed.

When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.  If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.

The customer's full name or business name.

A balance for a customer.

This holds information about the financial balance for the customer.

The date and time the balance was created.

The enterprise price for the Modeling App subscription, if they are on the enterprise plan.

The number of monthly API credits remaining in the balance. This is the number of credits remaining in the balance.

Both the monetary value and the number of credits are returned, but they reflect the same value in the database.

The monetary value of the monthly API credits remaining in the balance. This gets re-upped every month, but if the credits are not used for a month they do not carry over to the next month.

Both the monetary value and the number of credits are returned, but they reflect the same value in the database.

The number of stable API credits remaining in the balance. These do not get reset or re-upped every month. This is separate from the monthly credits. Credits will first pull from the monthly credits, then the stable credits. Stable just means that they do not get reset every month. A user will have stable credits if a Zoo employee granted them credits.

Both the monetary value and the number of credits are returned, but they reflect the same value in the database.

The monetary value of stable API credits remaining in the balance. These do not get reset or re-upped every month. This is separate from the monthly credits. Credits will first pull from the monthly credits, then the stable credits. Stable just means that they do not get reset every month. A user will have stable credits if a Zoo employee granted them credits.

Both the monetary value and the number of credits are returned, but they reflect the same value in the database.

This includes any outstanding, draft, or open invoices and any pending invoice items. This does not include any credits the customer has on their account. This amount is only returned if requested from the api.

The date and time the balance was last updated.

What strategy (algorithm) should be used for cutting? Defaults to Automatic.

Basic fillet cut. This has limitations, like the filletted edges can't touch each other. But it's very fast and simple.

More complicated fillet cut. It works for more use-cases, like edges that touch each other. But it's slower than the Basic method.

Tries the Basic method, and if that doesn't work, tries the CSG strategy.

The response from the `DefaultCameraCenterToScene` endpoint.

The response from the `DefaultCameraCenterToSelection` endpoint.

The response from the `DefaultCameraFocusOn` command.

The response from the `DefaultCameraGetSettings` command.

The response from the `DefaultCameraGetView` command.

The response from the `DefaultCameraLookAt` endpoint.

The response from the `DefaultCameraPerspectiveSettings` endpoint.

The response from the `DefaultCameraSetOrthographic` endpoint.

The response from the `DefaultCameraSetPerspective` endpoint.

API → MLGet a ML prompthidden

200 OK

Object Properties

Possible values

Object Properties

Array of

Object Properties

Object Properties

Object Properties

Possible values

Possible values

API → MLGet a ML prompt
hidden