This endpoint requires authentication by any member of an org. 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.

The date and time the balance was created.

DateTime

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.

double

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.

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

The Content-Location header for responses that are not the final destination. This is used to indicate where the resource can be found, when it is finished.

The location header for redirects and letting users know if there is a websocket they can listen to for status updates on their operation.

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

Get balance for your org.

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

Features

Getting Started

CAD Samples Gallery

Zoo Design Studio

Authentication

Errors

Generate a CAD model from text.

List all ML prompts.

Get a ML prompt.

List conversations

Converts a proprietary CAD format to KCL.

Create a custom ML model that is backed by one or more org datasets.

Retrieve the details of a single custom ML model so long as it belongs to the caller’s organization.

Update mutable metadata (name, system prompt) for a custom ML model owned by the caller's organization.

List the org datasets that are currently attached to a custom ML model owned by the caller’s organization.

Generate code completions for KCL.

Iterate on a CAD model with a prompt.

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

List text-to-CAD parts you've generated.

Get a text-to-CAD response.

Give feedback to a specific ML response.

Open a websocket to prompt the ML copilot.

Open a websocket which accepts modeling commands.

Modeling

Get API call metrics.

List API calls.

Get details of an API call.

List async operations.

Get an async operation.

List API calls for your org.

Get an API call for an org.

List API calls for your user.

Get an API call for a user.

List API calls for a user.

API Calls

List API tokens for your user.

Create a new API token for your user.

Get an API token for your user.

Delete an API token for your user.

API Tokens

Listen for callbacks to GitHub app authentication.

Get the consent URL for GitHub app authentication.

Listen for GitHub webhooks.

Apps

Execute a Zoo program in a specific language.

Create a terminal.

Executor

Get CAD file center of mass.

Convert CAD file from one format to another.

Convert CAD file with defaults.

Get CAD file density.

Get CAD file mass.

Get CAD file surface area.

Get CAD file volume.

File

Get OpenAPI schema.

Get ip address information.

Authorize an inbound auth request from our Community page.

Uploads files to public blob storage for debugging purposes.

Creates an internal telemetry event.

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

Return pong.

Get the pricing for our subscriptions.

Start an OAuth 2.0 Device Authorization Grant.

Confirm an OAuth 2.0 Device Authorization Grant.

Request a device access token.

Verify an OAuth 2.0 Device Authorization Grant.

Listen for callbacks for the OAuth 2.0 provider.

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

Revoke an OAuth2 token.

Oauth2

Get an org.

Update an org.

Create an org.

Delete an org.

Return the IAM policies customers should apply when onboarding an S3 dataset.

List every dataset that belongs to the caller's organization.

Register a new S3 dataset that Zoo can assume into on behalf of the caller's org.

Fetch a single dataset by ID so long as it belongs to the authenticated org.

Update dataset metadata or storage credentials for the caller's organization.

Delete a dataset owned by the caller's organization.

List the file conversions that have been processed for a given dataset owned by the caller's org.

Fetch the metadata and converted output for a single dataset conversion.

Retry a specific dataset conversion that failed previously for the caller's org.

Request a rescan of a dataset that belongs to the caller's org.

Return aggregate conversion stats for a dataset owned by the caller's org.

List members of your org.

Add a member to your org.

Get a member of your org.

Update a member of your org.

Remove a member from your org.

Get the privacy settings for an org.

Update the privacy settings for an org.

Get the SAML identity provider.

Update the SAML identity provider.

Create a SAML identity provider.

Delete an SAML identity provider.

Get the shortlinks for an org.

List orgs.

Get admin-only details for an organization.

Get a user's org.

Orgs

Get payment info about your org.

Update payment info for your org.

Create payment info for your org.

Delete payment info for your org.

Create a payment intent for your org.

List invoices for your org.

List payment methods for your org.

Delete a payment method for your org.

Get the subscription for an org.

Update the subscription for an org.

Create the subscription for an org.

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

Get balance for an org.

Update balance for an org.

Update the subscription for any org (admin override).

Create or update a price for a subscription plan.

Get payment info about your user.

Update payment info for your user.

Create payment info for your user.

Delete payment info for your user.

Get balance for your user.

Create a payment intent for your user.

List invoices for your user.

List payment methods for your user.

Delete a payment method for your user.

Set the default payment method for your user.

Get the subscription for a user.

Update the user's subscription.

Create the subscription for a user.

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

Get balance for an user.

Update balance for an user.

Payments

List service accounts for your org.

Create a new service account for your org.

Get an service account for your org.

Delete an service account for your org.

Service Accounts

Get the shortlinks for a user.

Create a shortlink for a user.

Redirect the user to the URL for the shortlink.

Update a shortlink for a user.

Delete a shortlink for a user.

Shortlinks

Create a new store coupon.

Store

Convert angle units.

Convert area units.

Convert current units.

Convert energy units.

Convert force units.

Convert frequency units.

Convert length units.

Convert mass units.

Convert power units.

Convert pressure units.

Convert temperature units.

Convert torque units.

Convert volume units.

Unit

Get your user.

Update your user.

Delete your user.

Update properties in the CRM

Get extended information about your user.

List user-visible feature flags enabled for the authenticated user.

Create a new support/sales ticket from the website contact form. This endpoint is authenticated.

Get balance for your org

200 OK

Object Properties

Object Properties

Possible values

Object Properties

Array of

One of

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

Possible values

One of

Object Properties

Possible values

Object Properties

Possible values