Skip to main content

​
Voyager API Introduction

The Voyager API provides programmatic access to your Lumafield CT scan data, enabling you to automate workflows, integrate with external systems, and build custom applications on top of Voyager’s powerful analysis platform.

​
What is the Voyager API?

The Voyager API is a RESTful API that allows you to:
  • Access your projects - List, create, update, and manage CT scan projects
  • Export data - Download meshes, volumes, radiographs, and analysis results
  • Run analyses - Trigger mesh generation, wall thickness analysis, integrity checks, and more
  • Automate workflows - Build scripts and integrations for quality control, reporting, and data pipelines
  • Manage at scale - Use bulk operations to process multiple projects efficiently

​
Key Capabilities

​
Project Management

  • Create and organize projects programmatically
  • Filter and search across projects
  • Archive, restore, copy, and move projects
  • Manage project metadata and tags

​
Data Access & Export

  • Export complete project packages (meshes, volumes, radiographs)
  • Download individual files with pre-signed URLs
  • Access downsampled data views for quick analysis
  • Export in multiple formats (STL, GLB, PLY, TIFF, NRRD)

​
Analysis Operations

  • Generate 3D meshes from scan data
  • Run wall thickness analysis
  • Run porosity and inclusion analysis and crack detection
  • Execute CAD comparisons
  • Run custom recipe workflows

​
Bulk Operations

  • Process multiple projects simultaneously
  • Bulk archive, copy, move, or delete
  • Batch recipe execution
  • Bulk data exports

​
Use Cases

​
Automated Quality Control

Monitor new scans, run analyses automatically, and generate reports when defects are detected.

​
Data Pipeline Integration

Export CT data and integrate it into your existing data infrastructure, PLM systems, or analytics platforms.

​
Batch Processing

Process large numbers of projects efficiently using bulk operations and recipe workflows.

​
Custom Workflows

Build custom applications that leverage Voyager’s analysis capabilities through the API.

​
Prerequisites

Before getting started with the Voyager API, you’ll need:
  • A Lumafield account with API access enabled
  • API credentials (email and password - you’ll receive a token after logging in)
  • API base URL - Use https://voyager.lumafield.com for cloud-based customers
  • Basic programming knowledge - The API works with any HTTP client, but we provide Python examples

​
API Base URLs

​
Cloud Customers

https://voyager.lumafield.com

​
On-Premises Customers

Your API URL will be provided by your Lumafield representative. It typically follows the pattern: 
https://your-instance.lumafield.com

​
Getting Help

  • Documentation: Browse the guides and API reference in this documentation
  • Support: Email support@lumafield.com for API access and technical questions
  • Examples: Check out the Examples & Use Cases section for real-world code samples

​
Next Steps

Ready to get started? Follow these steps:
  1. Quick Start Guide - Get up and running in 5 minutes
  2. Authentication - Learn how to authenticate your requests
  3. Making Your First Request - Make your first API call