Welcome to the Cloud Slicer's BETA Documentation! ⏳
Cloud Slicer Docs

Quickstart Guide 🚀

Get up and running with the Cloud Slicer API in under 5 minutes! Follow these steps to create your account, generate an API token, and start making your first API calls.

  1. Create Your Account

    1. Visit www.cloudslicer3d.com 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 Cloud Slicer 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) Cloud Slicer Banner
    1. 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 api.cloudslicer3d.com/docs
    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 Cloud Slicer Banner

    🎉 Congratulations! You're now authenticated and ready to explore the Cloud Slicer API.

  4. Make Your First API Call

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

    1. Find the POST /v1/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 POST 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:

  • Part Info - Check if your models are printable
  • Quote - Get instant pricing for your prints
  • Account management - Manage your uploads and account info

All API endpoints require authentication with your Bearer token. Make sure to include it in your requests!

Need help? Check out our API Playground for detailed documentation on all available endpoints.

Last modified on
Introduction