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

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.

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.

Create a shortlink for a user.

Zookeeper

Zookeeper: The Conversational CAD Agent For Parametric Modeling

Automation

Automating Your Workflow

File Formats

A Practical Overview of CAD File Formats

KCL: A Programming Language for Parametric CAD

Geometry Engine

Zoo CAD Engine Overview

Overview

Getting Started

Point-and-Click Tutorials

Parametric Modeling

Assemblies

Geometric Analysis

3D Design

Modes

Queue and Steer

Zoodle

Revertible AI Changes

Project Instructions

ML / AI

Simulation

GD&T Annotations (MBD)

Documentation

Import

Export

Version Control

Project Libraries

Cloud Sync

Default Project Folder

Aquarium

Data Management

Technical Support

Zoo Design Studio Stream

System Requirements

Project Browser

Modeling Area

New Window

Feature Tree

Bodies Pane

Code Editor

File Explorer

Variables Pane

Command Bar

AI Chat

Top Bar

Status Bar

Settings

Appearance

Workspace

Features

Aquarium CAD Gallery

Zoo Design Studio

Engine API

Agent API

File Format API

Endpoint billing

Authentication

Errors

List conversations

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.

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 a Zookeeper agent instance.

Open a websocket to prompt the ML copilot.

Opens a WebSocket to a Zoo KittyCAD engine instance.

Modeling

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.

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

List Factory jobs owned by your organization.

List finishes currently available for customer Factory submissions.

List your personal Factory jobs.

List materials currently available for customer Factory submissions.

Factory

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.

List all active announcements.

Return pong.

Verify OAuth account linking and complete the authentication.

List org OAuth apps.

Create an org OAuth app.

Get an org OAuth app.

Update an org OAuth app.

Delete an org OAuth app.

List personal OAuth apps.

Create a personal OAuth app.

Get a personal OAuth app.

Update a personal OAuth app.

Delete a personal OAuth app.

Oauth2

Get an org.

Update an org.

Create an org.

Get the authenticated organization's aggregate-usage collection threshold.

Set the authenticated organization's aggregate-usage collection threshold.

Restore the default for the authenticated organization's aggregate-usage collection threshold.

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

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.

Bulk-download KCL outputs for successful dataset conversions.

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.

Download the original source file for a specific dataset conversion.

Retrigger a specific dataset conversion for the caller's org.

Request a retrigger of conversions for a dataset that belongs to the caller's org.

Search dataset conversions by conversion ID or file path.

Run semantic search across chunked conversion outputs for a dataset.

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

Upload source files into a Zoo-managed dataset.

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 every skill that belongs to the caller's 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.

List invoices for your org.

Redirect to a fresh Stripe-hosted payment-method update link for your org.

List payment methods for your org.

Get the subscription for an org.

Update the subscription for an org.

Create the subscription for an org.

Get your personal aggregate-usage collection threshold.

Set your personal aggregate-usage collection threshold.

Restore the default for your personal aggregate-usage collection threshold.

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.

List invoices for your user.

Redirect to a fresh Stripe-hosted payment-method update link for your user.

List payment methods 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.

Payments

List the active categories available for project submissions.

List publicly visible community projects for the website/gallery.

Get one publicly visible community project.

Download a published public project as a tar archive.

Fetch the public thumbnail for a published project.

Add the authenticated user's upvote to a published community project.

Remove the authenticated user's upvote from a published community project.

List the authenticated user's projects.

Create a draft project for the authenticated user.

Get one of the authenticated user's projects.

Replace one of the authenticated user's projects.

Delete one of the authenticated user's projects.

Download one of the authenticated user's projects as a tar archive.

Move one of the authenticated user's projects into their active organization library.

Move an organization project back to its creator's personal library.

Projects

API Reference

Developer Tools

Create a shortlink for a user

HTTP Request

application/json

password:

restrict_to_org:

url:

}

Response

201 Created

key:

url:

}

Examples

Create a shortlink for a user

HTTP Request

{ ... }application/json

password:

restrict_to_org:

url:

}

Response

201 Created

{ ... }

key:

url:

}

Examples

application/json