This includes billing address, phone, and name.

This endpoint requires authentication by an org admin. It gets the payment information for the authenticated user's org.

The resource representing a payment "Customer".

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 payment info about your org.

This includes billing address, phone, and name.

This endpoint requires authentication by an org admin. It updates the payment information for the authenticated user's org.

Update payment info for your org.

This includes billing address, phone, and name.

This endpoint requires authentication by the org admin. It creates the payment information for the authenticated user's org.

Create payment info for your org.

This includes billing address, phone, and name.

This endpoint requires authentication by an org admin. It deletes the payment information for the authenticated user's org.

Delete payment info for your org.

This endpoint requires authentication by an org admin. It gets the balance information for the authenticated user's org.

If you would like to return the total due for a user. This makes the API call take longer so it is off by default.

include_total_due

A balance for a customer.

This holds information about the financial balance for the customer.

Get balance for your org.

This endpoint requires authentication by the org admin. It creates a new payment intent for the authenticated user's org's org.

Create a payment intent for your org.

This endpoint requires authentication by an org admin. It lists invoices for the authenticated user's org.

Array_of_Invoice

List invoices for your org.

This endpoint requires authentication by an org admin. It lists payment methods for the authenticated user's org.

Array_of_PaymentMethod

List payment methods for your org.

This endpoint requires authentication by an org admin. It deletes the specified payment method for the authenticated user's org.

Delete a payment method for your org.

This endpoint requires authentication by an org admin. It gets the subscription for the authenticated user's org.

Get the subscription for an org.

This endpoint requires authentication by an org admin. It updates the subscription for the authenticated user's org.

A struct of Zoo product subscriptions an organization can request.

Update the subscription for an org.

This endpoint requires authentication by an org admin. It creates the subscription for the authenticated user's org.

Create the subscription for an org.

This endpoint requires authentication by an org admin. It will return an error if the org's information is not valid for automatic tax. Otherwise, it will return an empty successful response.

Validate an orgs's information is correct and valid for automatic tax.

Validate an orgs's information is correct and valID for automatic tax.

This endpoint requires authentication by a Zoo employee. It gets the balance information for the specified org.

Get balance for an org.

This endpoint requires authentication by a Zoo employee. It updates the balance information for the specified org.

Update balance for an org.

This includes billing address, phone, and name.

This endpoint requires authentication by any Zoo user. It gets the payment information for the authenticated user.

Get payment info about your user.

This includes billing address, phone, and name.

This endpoint requires authentication by any Zoo user. It updates the payment information for the authenticated user.

Update payment info for your user.

This includes billing address, phone, and name.

This endpoint requires authentication by any Zoo user. It creates the payment information for the authenticated user.

Create payment info for your user.

This includes billing address, phone, and name.

This endpoint requires authentication by any Zoo user. It deletes the payment information for the authenticated user.

Delete payment info for your user.

This endpoint requires authentication by any Zoo user. It gets the balance information for the authenticated user.

Get balance for your user.

This endpoint requires authentication by any Zoo user. It creates a new payment intent for the authenticated user.

Create a payment intent for your user.

This endpoint requires authentication by any Zoo user. It lists invoices for the authenticated user.

List invoices for your user.

This endpoint requires authentication by any Zoo user. It lists payment methods for the authenticated user.

List payment methods for your user.

This endpoint requires authentication by any Zoo user. It deletes the specified payment method for the authenticated user.

Delete a payment method for your user.

This endpoint requires authentication by any Zoo user. It gets the subscription for the user.

Get the subscription for a user.

This endpoint requires authentication by any Zoo user. It updates the subscription for the user.

A struct of Zoo product subscriptions a user can request.

Update the user's subscription.

This endpoint requires authentication by any Zoo user. It creates the subscription for the user.

Create the subscription for a user.

This endpoint requires authentication by any Zoo user. It will return an error if the user's information is not valid for automatic tax. Otherwise, it will return an empty successful response.

Validate a user's information is correct and valid for automatic tax.

Validate a user's information is correct and valID for automatic tax.

This endpoint requires authentication by a Zoo employee. It gets the balance information for the specified user.

Get balance for an user.

This endpoint requires authentication by a Zoo employee. It updates the balance information for the specified user.

Update balance for an user.

payments

Payments

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.

DateTime

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

APIPayments

Endpoints