TLDR Highlevel steps:
- Create your Cloud Slicer account
- In the Dashboard:
- Generate an API token
- Create a filament config profile
- Create your printer config profile
- In the API Playground:
- Authenticate with the API in our Swagger Docs playground
- Make your first API call to
/v1/fileto upload a file - Make an API call to
/v1/quote/{file-id}using yourfile_id,printer_id, andfilament_idto get a quote for your uploaded file
-
Create Your Account
- Visit www.cloudslicer3d.com 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
Important: 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 Cloud Slicer account
- Navigate to the dashboard - you'll be redirected here automatically after login
- Click on the
Tokenstab in the left sidebar - Create a new token by clicking the
New Tokenbutton - Configure your token:
- Give it a descriptive name (e.g., "My First Token")
- Set the expiration in days OR leave blank for no expiration
- Copy the generated token immediately and store it securely
Important: You will only see the token once! Make sure to copy and save it in a secure location before closing the popup.
-
Create a Printer Config
- Click on the
Printerstab in the left sidebar - Click the
+icon in the top right corner - Configure your printer settings to match what you currently have in your local slicer application
- Save the printer configuration
Note: Keep track of your
printer_idas you will use this in your API calls. - Click on the
-
Create a Filament Config
- Click on the
Filamentstab in the left sidebar - Click the
+icon in the top right corner - Configure your filament profile to match what you will use for printing
- Save the filament configuration
Note: Hold on to your
filament_idas you will use this in your API calls. - Click on the
-
Authenticate with the API
- Navigate to the API playground at api.cloudslicer3d.com/docs
- Click the
lock iconin the top right corner - Paste your JWT token from Step 2 into the authorization field
- Click
Authorize
You're now authenticated and ready to explore the Cloud Slicer API.
-
Make Your First Set of API Calls
Upload your first STL file:
- Find the
POST /v1/fileendpoint in the API documentation - Expand the tab to reveal the POST request details
- Upload an STL file using the
choose filebutton to open up your file explorer - Execute the request
- Copy the
file_idfrom the response
Create your first quote:
- Find the
POST /v1/quote/{file-id}endpoint in the API documentation - Expand the tab to reveal the POST request details
- Add Details:
- Fil in the path parameter with the
file_idfrom the previous upload step - Fill in both the
printer_idandfilament_idfields in the request body with the IDs created in Steps 3 and 4 - Fill in the print settings for your quote
- Fil in the path parameter with the
- Execute the request
- Copy the file_id from the response
You will now see activity in your dashboard since you have uploaded a file and generated a quote
- Find the
Reminder: 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.