Glossi API: Getting Started Guide

Beta: The Glossi API is currently in beta. Endpoints, request/response formats, and behavior may change as we iterate. If you run into issues or have feedback, reach out at support@glossi.io.

This guide walks you through using the Glossi API to upload 3D models, create projects, and render high-quality images and videos programmatically.

Prerequisites

Before you begin, you'll need:

A Glossi account with an active workspace
An API key (created in Workspace Settings → API Keys)
A tool for making HTTP requests (Postman, cURL, or your programming language of choice)

Get Your API Key

Log in to Glossi
Go to Settings → Workspace → API Keys
Click Create API Key
Give it a name (e.g., "n8n Integration")
Copy your API key immediately - you won't be able to see it again!

Your API key looks like this:

glsi_xxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Important: Keep your API key secret. Don't commit it to version control or share it publicly.

Authentication

Include your API key in the X-API-Key header for all requests:

curl https://api.glossi.app/api/v1/models \
  -H "X-API-Key: glsi_xxxxxxxxxx_xxxxx"

Choose Your Workflow

Glossi offers three ways to use the API:

Pipelines (Fully Automated)

Connect an external folder (OneDrive, etc.) to Glossi. Drop files in, get renders out -- no code or manual steps needed after initial setup.

Best for:

Recurring production workflows (e.g. SolidWorks → renders)
Processing large volumes of models (100s to 1000s)
Teams that want a "set it and forget it" solution

View Pipelines Guide →

Simple Workflow

The Jobs endpoint combines everything into a single workflow - upload models, create projects, and render in one streamlined process.

Best for:

Automation tools like n8n or Zapier
Batch processing multiple models
When you want Glossi to handle the orchestration

View Simple Workflow Guide →

Complete Workflow

Individual endpoints give you full control over each step - create models, upload files, create projects, and trigger renders separately.

Best for:

Custom integrations
When you need fine-grained control
Building your own orchestration logic

View Complete Workflow Guide →

Quick Comparison

Feature	Pipelines	Simple Workflow	Complete Workflow
API calls needed	1 (setup)	4	8+
Orchestration	Fully automatic	Automatic	Manual
File handling	Auto-detect from folder	Upload via API	Upload via API
Progress tracking	Dashboard + API	Built-in	Poll each step
Best for	Production workflows	Automation tools	Custom integrations

Webhooks

Instead of polling for status, receive notifications when things complete.

View Webhooks Guide →

Base URL

All API requests should be made to:

https://api.glossi.app/api/v1

Error Handling

All errors follow a consistent format:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Model name is required"
  }
}

Common Error Codes

Code	HTTP Status	Description
`MISSING_API_KEY`	401	No API key provided
`INVALID_API_KEY`	401	API key is invalid or expired
`VALIDATION_ERROR`	400	Request body is invalid
`MODEL_NOT_FOUND`	404	Model ID doesn't exist
`PROJECT_NOT_FOUND`	404	Project ID doesn't exist
`PLAN_LIMIT_REACHED`	403	Workspace has reached plan limits
`INTERNAL_ERROR`	500	Something went wrong on our end

Rate Limits

API requests are rate limited to ensure fair usage:

100 requests per minute per API key
10 concurrent renders per workspace

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Need Help?

Support: Contact us at support@glossi.io
Community: Join our Discord for questions and updates

Glossi API: Getting Started Guide

On this page