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.

This includes information on any of our other distributed systems it is connected to.

You must be a Zoo employee to perform this request.

Metadata about our currently running server.

This is mostly used for internal purposes and debugging.

Get the metadata about our currently running server.

Information about an ip address. Represents geographical and network-related information.

This is necessary for some preflight requests, specifically POST, PUT, and DELETE.

The format the output file should be converted to.

output_format

Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>

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

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.

The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>

The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>

The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>

Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.

This operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not `Completed` or `Failed`.

If we should output the kcl for the model.

This endpoint requires authentication by a Zoo employee. The API calls are grouped by the parameter passed.

group_by

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.

Array_of_ApiCallQueryGroup

This endpoint requires authentication by a Zoo employee. The API calls are returned in order of creation, with the most recently created API calls first.

Maximum number of items returned by a single call

limit

Token returned by previous call to retrieve the subsequent page

page_token

sort_by

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

This endpoint requires authentication by any Zoo user. It returns details of the requested API call for the user.

If the user is not authenticated to view the specified API call, then it is not returned.

Only Zoo employees can view API calls for other users.

An API call with the price.

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

This is different than OAuth 2.0 authentication for users. This endpoint grants access for Zoo to access user's repos.

The user doesn't need Zoo OAuth authorization for this endpoint, this is purely for the GitHub permissions to access repos.

Listen for callbacks to GitHub app authentication.

Information about a third party app client.

Get the consent URL for GitHub app authentication.

For async file conversion operations, this endpoint does not return the contents of converted files (`output`). To get the contents use the `/async/operations/{id}` endpoint.

This endpoint requires authentication by a Zoo employee.

status

The async API call was uploaded to be converted.

Get the status and output of an async operation.

This endpoint requires authentication by any Zoo user. It returns details of the requested async operation for the user.

If the user is not authenticated to view the specified async operation, then it is not returned.

Only Zoo employees with the proper access can view async operations for other users.

The body of the form for email authentication.

Create an email verification request for a user.

The URL to redirect back to after we have authenticated.

callback_url

email

token

Listen for callbacks for email authentication for users.

The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.

provider_id

The nonce and redirect URL sent to us by Discourse

Authorize an inbound auth request from our Community page.

Do NOT send files here that you don't want to be public.

Array_of_Url

Uploads files to public blob storage for debugging purposes.

We collect anonymous telemetry data for improving our product.

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.

This endpoint returns the cartesian coordinate in world space measure units.

In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.

Get the center of mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

output_unit

Centimeters <https://en.wikipedia.org/wiki/Centimeter>

Feet <https://en.wikipedia.org/wiki/Foot_(unit)>

Inches <https://en.wikipedia.org/wiki/Inch>

Meters <https://en.wikipedia.org/wiki/Meter>

Millimeters <https://en.wikipedia.org/wiki/Millimeter>

Yards <https://en.wikipedia.org/wiki/Yard>

src_format

The format the file should be converted to.

If you wish to specify the conversion options, use the `/file/conversion` endpoint instead.

Convert a CAD file from one format to another. If the file being converted is larger than 25MB, it will be performed asynchronously.

If the conversion is performed synchronously, the contents of the converted file (`output`) will be returned as a base64 encoded string.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.

This endpoint assumes if you are giving a material mass in a specific mass units, we return a density in mass unit per cubic measure unit.

In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.

Get the density of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

material_mass

material_mass_unit

Grams <https://en.wikipedia.org/wiki/Gram>

Kilograms <https://en.wikipedia.org/wiki/Kilogram>

Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>

lang

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>

The output file we want to get the contents for (the paths are relative to where in litterbox it is being run). You can denote more than one file with a comma separated list of string paths.

output

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>

Execute a Zoo program in a specific language.

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.

This endpoint assumes if you are giving a material density in a specific mass unit per cubic measure unit, we return a mass in mass units. The same mass units as passed in the material density.

In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.

Get the mass of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

material_density

material_density_unit

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.

This endpoint returns the square measure units.

In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.

Get the surface area of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>

Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>

Square feet <https://en.wikipedia.org/wiki/Square_foot>

Square inches <https://en.wikipedia.org/wiki/Square_inch>

Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>

Square meters <https://en.wikipedia.org/wiki/Square_meter>

Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>

Square yards <https://en.wikipedia.org/wiki/Square_mile>

We assume any file given to us has one consistent unit throughout. We also assume the file is at the proper scale.

This endpoint returns the cubic measure units.

In the future, we will use the units inside the file if they are given and do any conversions if necessary for the calculation. But currently, that is not supported.

Get the volume of an object in a CAD file. If the file is larger than 25MB, it will be performed asynchronously.

If the operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>

Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>

Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>

Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>

Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>

US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>

US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>

Liters (l) <https://en.wikipedia.org/wiki/Litre>

Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>

This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.

You must be a Zoo employee to use this endpoint.

discord_id

An API token.

These are used to authenticate users with Bearer authentication.

Get an API token for a user by their discord id.

This endpoint removes the session cookie for a user.

For text-to-cad prompts, this will always return the STEP file contents as well as the format the user originally requested.

This endpoint requires authentication by a Zoo employee.

The ML prompts are returned in order of creation, with the most recently created ML prompts first.

This endpoint requires authentication by a Zoo employee.

A request to generate KCL code completions.

Even if you give specific ranges to edit, the model might change more than just those in order to make the changes you requested without breaking the code.

You always get the whole code back, even if you only changed a small part of it.

This operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

This endpoint will soon be deprecated in favor of the `/ml/text-to-cad/multi-file/iteration` endpoint. In that the endpoint path will remain but it will have the same behavior as `ml/text-to-cad/multi-file/iteration`.

This endpoint can iterate on multi-file models.

Even if you give specific ranges to edit, the model might change more than just those in order to make the changes you requested without breaking the code.

You always get the whole code back, even if you only changed a small part of it. This endpoint will always return all the code back, including files that were not changed. If your original source code imported a stl/gltf/step/etc file, the output will not include that file since the model will never change non-kcl files. The endpoint will only return the kcl files that were changed.

This operation is performed asynchronously, the `id` of the operation will be returned. You can use the `id` returned from the request to get status information about the async operation from the `/async/operations/{id}` endpoint.

Body for iterating on models from text prompts.

A response from a text to CAD multi-file iteration.

Iterate on a multi-file CAD model with a prompt.

This endpoint is designed to be accessed from an *unauthenticated* API client. It generates and records a `device_code` and `user_code` which must be verified and confirmed prior to a token being granted.

The request parameters for the OAuth 2.0 Device Authorization Grant flow.

Start an OAuth 2.0 Device Authorization Grant.

This endpoint is designed to be accessed by the user agent (browser), not the client requesting the token. So we do not actually return the token here; it will be returned in response to the poll on `/oauth2/device/token`.

The request parameters to confirm the `user_code` for the OAuth 2.0 Device Authorization Grant.

Confirm an OAuth 2.0 Device Authorization Grant.

This endpoint should be polled by the client until the user code is verified and the grant is confirmed.

The form for a device access token request.

This endpoint should be accessed in a full user agent (e.g., a browser). If the user is not logged in, we redirect them to the login page and use the `callback_url` parameter to get them to the UI verification form upon logging in. If they are logged in, we redirect them to the UI verification form on the website.

app_name

user_code

Verify an OAuth 2.0 Device Authorization Grant.

provider

code

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

id_token

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

state

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 }`

user

Listen for callbacks for the OAuth 2.0 provider.

This specific endpoint listens for posts of form data.

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

Get the consent URL and other information for the OAuth 2.0 provider.

This endpoint is designed to be accessed from an *unauthenticated* API client.

The request parameters for the OAuth 2.0 token revocation flow.

In order to delete an org, you must first delete all of its members, except yourself.

You must also have no outstanding invoices or unpaid balances.

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

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

This endpoint requires authentication by a Zoo user that is not already in an org. It creates a new org for the authenticated user and makes them an admin.

The user-modifiable parts of an organization.

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

This includes all API calls that were made by users in the org.

This endpoint requires authentication by an org admin. It returns the API calls for the authenticated user's org.

The API calls are returned in order of creation, with the most recently created API calls first.

This endpoint requires authentication by an org admin. It returns details of the requested API call for the user's org.

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

role

Members of an org can not modify an org, but they belong in the org.

If the user exists, this will add them to your org. If they do not exist, this will create a new user and add them to your org.

In both cases the user gets an email that they have been added to the org.

If the user is already in your org, this will return a 400 and a message.

If the user is already in a different org, this will return a 400 and a message.

This endpoint requires authentication by an org admin. It adds the specified member to the authenticated user's org.

This endpoint requires authentication by an org admin. It removes the specified member from the authenticated user's org.

user_id

This endpoint requires authentication by an org admin. It gets the specified member of the authenticated user's org.

This endpoint requires authentication by an org admin. It updates the specified member of the authenticated user's 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.

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

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.

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.

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

A balance for a customer.

This holds information about the financial balance for the customer.

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

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

Array_of_Invoice

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

Array_of_PaymentMethod

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

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

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

A struct of Zoo product subscriptions an organization can request.

This endpoint requires authentication by an org admin. It updates the subscription for the authenticated user's 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.

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

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

This endpoint requires authentication by an org admin.

Parameters for creating a SAML identity provider.

This endpoint requires authentication by an org admin. It returns the service accounts for the organization.

The service accounts are returned in order of creation, with the most recently created service accounts first.

This endpoint requires authentication by an org admin. It creates a new service account for the organization.

An optional label for the service account.

label

A service account.

These are used to authenticate orgs with Bearer authentication.

This works just like an API token, but it is tied to an organization versus an individual user.

Create a new service account for your org.

This endpoint requires authentication by an org admin. It deletes the requested service account for the organization.

This endpoint does not actually delete the service account from the database. It merely marks the token as invalid. We still want to keep the service account in the database for historical purposes.

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

This endpoint requires authentication by an org admin. It returns details of the requested service account for the organization.

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

This endpoint requires authentication by a Zoo employee. The orgs are returned in order of creation, with the most recently created orgs first.

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

You must be a Zoo employee to perform this request.

The price for an enterprise subscription.

Set the enterprise price for an organization.

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

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

This is the ultimate source of truth for the pricing of our subscriptions.

Map_of_Array_of_ZooProductSubscription

This endpoint requires authentication by a Zoo employee. It creates a new store coupon.

API → Unit → Convert pressure units

Parameters

input_unit

Possible values

output_unit

Possible values

value

Returns

200 OK

body

Object Properties

completed_at

created_at

error

id

input

input_unit

Possible values

output

output_unit

Possible values

started_at

status

Possible values

updated_at

user_id