Welcome to the Quote3D Documentation!

Quickstart Guide

Get up and running with the Quote3D API in under 5 minutes! For external integrations, call endpoints from https://api.quote3d.com/v2. Follow these steps to create your account, generate an API token, and start making your first API calls.

1

Create Your Account

  1. Visit the Quote3D dashboard to sign up for a new account
  2. Fill out the registration form with your details
  3. 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!

2

Generate Your API Token

  1. Log into your Quote3D account
  2. Navigate to the dashboard - you'll be redirected here automatically after login
  3. Click on the Tokens tab in the left sidebar
  4. Create a new token by clicking the New Token button
  5. Configure your token
    • Give it a descriptive name (e.g., "My First Token")
    • Set the expiration in days (leave blank for no expiration)
  6. 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.

3

Authenticate with the API

  1. Navigate to the API playground at /docs/playground
  2. Click the lock icon in the top right corner
  3. Paste your JWT token from Step 2 into the authorization field
  4. Click Authorize

Congratulations! You're now authenticated and ready to explore the Quote3D API.

4

Make Your First API Call

Ready to test it out? Try uploading your first STL file:

  1. Find the POST https://api.quote3d.com/v2/file endpoint in the API documentation
  2. Expand the tab to reveal the POST request details
  3. Upload an STL file using the choose file button to open up your file explorer
  4. 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.

Endpoint Decision Tree

Use this quick path when deciding which endpoint to call next on https://api.quote3d.com/v2.

  1. Need to upload from your backend? Use POST https://api.quote3d.com/v2/file with your Bearer token.
  2. Need direct browser upload without exposing your token? Get an upload id from GET https://api.quote3d.com/v2/file/upload-id, then upload with POST https://api.quote3d.com/v2/file/public/{upload_id}.
  3. Need size/fit validation before pricing? Call POST https://api.quote3d.com/v2/printability/{file_id}.
  4. Need a quote? Start with POST https://api.quote3d.com/v2/file/quote/{file_id}.
  5. Waiting for quote completion? Poll GET https://api.quote3d.com/v2/jobs/{job_id} until COMPLETED, FAILED, or CANCELLED.
  6. Need stored quote history/details? Use GET https://api.quote3d.com/v2/quotes and GET https://api.quote3d.com/v2/quotes/{quote_id}.

Note: If you do not send technology, printer, or material details in quote requests, the API falls back to your default user profile settings.

Common Errors and What To Do Next

Fast actions for the most common edge cases.

429 Rate Limited: Read X-RateLimit-* and Retry-After headers, wait, then retry with exponential backoff.

Invalid File Format: Upload only STL, 3MF, or OBJ. Re-export the model and verify file integrity.

Model Does Not Fit Bed: Run printability check first, reduce model scale, or select a larger printer profile/build volume.

Unit Anomaly Warning: Your model likely uses inch/meter scale. Re-export in millimeters (mm) and retry.

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 in your preferred currency 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.