To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.

Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.

Extended user information.

This is mostly used for internal purposes. It returns a mapping of the user's information, including that of our third party services we use for users: Stripe

If the user should be blocked and the reason why.

If we can train on the user's data. If the user is a member of an organization, the organization's setting will override this.

DateTime

The date and time the email address was verified.

The user's Hubspot ID. This is mostly used for internal mapping.

The image avatar for the user. This is a URL.

String

If the user is tied to a service account.

The name of the user. This is auto populated at first from the authentication provider (if there was a name). It can be updated by the user by updating their `first_name` and `last_name` fields.

The user's Stripe ID. This is mostly used for internal mapping.

The date and time the user 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 extended information about a user.

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

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.

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

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.

Set the enterprise price 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.

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

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.

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.

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

Get the OAuth2 providers for your user.

Get the privacy settings for a user.

Update the user's privacy settings.

Get a session for your user.

List users.

List users with extended information.

Get a user.

Update a subscription for a user.

Creates a new support/sales ticket from the website contact form. This endpoint is for untrusted

API → UsersGet extended information about a user
hidden

Parameters

id

Returns

200 OK

body

Object Properties

block

Possible values

can_train_on_data

company

created_at

deletion_scheduled

discord

email

email_verified

first_name

github

hubspot_contact_id

id

image

is_onboarded

is_service_account

last_name

name

phone

stripe_id

updated_at

API → UsersGet extended information about a userhidden

200 OK

Object Properties

Possible values

API → UsersGet extended information about a user
hidden