Quickstart Guide 🚀
Get up and running with the Quote3D API in under 5 minutes! Follow these steps to create your account, generate an API token, and start making your first API calls.
Create Your Account
- Visit the Quote3D dashboard to sign up for a new account
- Fill out the registration form with your details
- Check your email and click the confirmation link to fully activate your account
Make sure to confirm your email address or your account will not be fully activated and you will not be able to access the API!
Generate Your API Token
- Log into your Quote3D account
- Navigate to the dashboard - you'll be redirected here automatically after login
- Click on the Tokens tab in the left sidebar
- Create a new token by clicking the New Token button
- Configure your token
- Give it a descriptive name (e.g., "My First Token")
- Set the expiration in days (leave blank for no expiration)
- Copy the generated token immediately and store it securely
You will only see the token once! Make sure to copy and save it in a secure location before closing the popup.
Authenticate with the API
- Navigate to the API playground at /docs/playground
- Click the lock icon in the top right corner
- Paste your JWT token from Step 2 into the authorization field
- Click
Authorize
🎉 Congratulations! You're now authenticated and ready to explore the Quote3D API.
Make Your First API Call
Ready to test it out? Try uploading your first STL file:
- Find the POST /v2/file endpoint in the API documentation
- Expand the tab to reveal the POST request details
- Upload an STL file using the choose file button to open up your file explorer
- Execute the request
The response will include a file ID that you can use for:
- Checking dimensions and printability
- Generating quotes for automated instant pricing estimates
- Managing the uploaded file to save on your cloud storage
The file_id acts as your key to manage and reference your uploaded files in subsequent API calls. It is the unique identifier by which all other API calls stem from.
What's Next?
Now that you're set up, explore these key features:
- File Management - Upload, download, and manage your 3D model files (STL, 3MF, OBJ)
- Printability Check - Verify if your models fit your printer dimensions
- Quote Generation - Get instant pricing with detailed material usage and print time estimates
- Quote History - Access all your past quotes and manage them
- Webhooks - Receive real-time notifications for quote completions and file uploads
- Analytics - Track your usage, popular materials, and cost trends
- Account Management - Monitor your quotas, usage statistics, and subscription details
Important: All API endpoints require authentication with your Bearer token. Make sure to include it in the Authorization header of every request.
Example: Authorization: Bearer YOUR_TOKEN_HERE
Need help? Check out our Core Concepts guide or explore the API Playground for interactive documentation.