Zoo API Overview
Zoo provides APIs for building hardware design tools and automations. You can use them to create or edit geometry, convert CAD files, run AI-assisted workflows, and manage the account objects around those systems.
Think of the API as the programmable layer inside Zoo Developer Tools. If you want to connect Zoo to your own product, script, backend, or internal workflow, start here.
Zoo's APIs are organized around REST. They use predictable URLs, standard HTTP methods, bearer-token authentication, and JSON request and response bodies.
The root endpoint / returns the OpenAPI specification, which is useful if you want to inspect the schema or generate tooling from it.
Available APIs
Most developers start with one of these product areas, then move into the deeper endpoint reference for the exact operations they need.
Modeling API
Create or modify geometry with Zoo's CAD engine. Use it when you need programmable modeling operations instead of manual CAD work.
File API
Upload, convert, and inspect CAD files so you can move geometry between formats and downstream tools.
ML API
Run AI-assisted design workflows such as text-to-CAD and other machine learning features built into Zoo.
Units API
Convert and normalize engineering units so values stay consistent across tools, teams, and measurement systems.
Users, Orgs, and Access
Manage the account-level objects around an integration, including users, organizations, tokens, and service accounts.
Usage and Debugging
Inspect API calls for debugging, auditing, and billing, especially when you need to understand what a client actually sent.
The full reference also includes API tokens, service accounts, OAuth flows, payments, and other supporting endpoints.
Typical Workflow
Step 1
Start with a model or file
Bring your own geometry, upload a CAD file, or generate a starting point with one of Zoo's APIs.
Step 2
Run an operation
Convert a file, apply a modeling command, or invoke an ML workflow depending on the job you need done.
Step 3
Inspect the result
Check the response payload, returned metadata, or follow-up resources to confirm the operation completed the way you expected.
Step 4
Export or hand off the output
Pass the result to another tool, save it in your own system, or trigger the next step in your workflow.
Getting Started
- Create an API token from your Zoo account. That token is what your app, script, or server will send with requests.
- Make your first authenticated call. A simple request to
/useris an easy way to verify that your token and environment are set up correctly. - Choose a client language or use plain HTTP. Zoo supports curl, TypeScript, Python, Rust, and Go clients.
- Keep going with the authentication guide, the error reference, or one of the API areas above.
Start With These
If you are deciding where to click next, these are the most practical entry points for a first successful integration.
Verify authentication
Start by confirming your token works and learning the request pattern every Zoo integration uses.
Try a file workflow
If you want a fast first win, start with file operations such as upload, conversion, or export.
Try AI-assisted design
Use the ML API if your first goal is text-to-CAD or another AI-assisted design workflow.
Move into modeling
Use the Modeling API when you need direct geometry operations and more control over the CAD workflow.
Official clients
Official clients are available for TypeScript, Python, Rust, and Go. Use the language switcher above to see supported surfaces, then jump into the reference for the exact endpoint examples you need.